https://gitee.com/ggkt/SpringBootMybatisPlus
step1:配置pom.xml文件
<!-- swagger start --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency> <!-- swagger end-->
step2:修改application.properties文件
增加一行
swagger.enabled=true
step3:配置config文件
package com.example.ggkt.config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
/**
* Title: Swagger
* Description:接口測試(可用、可不用)
* @author ggkt
* @date 2021年6月5日
*
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Value(value = "${swagger.enabled}")
private Boolean swaggerEnabled;
@Bean
public Docket createUserApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.groupName("用戶管理")
// 是否開啓
.enable(swaggerEnabled).select()
// 掃描的路徑包
.apis(RequestHandlerSelectors.basePackage("com.example.ggkt.user"))
// 指定路徑處理PathSelectors.any()代表所有的路徑
.paths(PathSelectors.any()).build().pathMapping("/");
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口文檔")
.description("API")
.version("1.0.0")
.build();
}
}
step4:controller層類添加註解
類級註解
@Api(tags="業績管理")
方法註解:
@ApiOperation("業績管理列表")
屬性註解:
@ApiModelProperty("主鍵Id")