springboot內建knife4j

項目： https://github.com/nlxs0511/springmybatisplus.git

送出版本：內建knife4j實作風格化API文檔

1.pom.xml knife4j-spring-boot-starter的版本自己決定

<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
           

2.配置knifeconfig

package com.test.mybatisplus.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import springfox.documentation.service.Contact;
/**
 * @Description:內建knife4j實作風格化API文檔
 * * @param null
 * @Return:
 * @Author: hf
 * @Time: 2021/2/22 17:03
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Knife4jConfig {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                // 這裡指定Controller掃描包路徑
                .apis(RequestHandlerSelectors.basePackage(
                        "com.test.mybatisplus.knife4jcontroller"))
                .paths(PathSelectors.any()).build();
        return docket;
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("kry", "", "");
        return new ApiInfoBuilder().title("knife測試").
                description("knife測試描述").contact(contact).version("1.0.0").build();
    }
}
           

滑鼠處可自定義掃描路徑

3.Knife4jTsetController

package com.test.mybatisplus.knife4jcontroller;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import com.test.mybatisplus.entity.PressInfoEntity;
import com.test.mybatisplus.service.PressInfoService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.*;


/**
 * @Description mybatis-plus 通用curd測試
 * @project xr
 * @author：hf
 * @date：
 * @company:人生有限公司
 */
@Api(tags="Knife4jTsetController")
@RestController
@RequestMapping("knife")
@Slf4j
public class Knife4jTsetController {
 
    @ApiOperation(value = "測試index接口", nickname = "測試IndexController的index接口")
    @GetMapping("/index")
    public String index() {
        return "測試IndexController的index接口...";
    }


}
           

4.啟動項目 請求http://localhost:8084/mybatisplus//doc.html#/home