一、引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
二、添加config配置文件
package com.example.demo.transactional.utils;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
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.EnableSwagger2WebMvc;
/**
* Swagger配置
*/
@Configuration
@EnableSwagger2WebMvc
@EnableKnife4j
@AllArgsConstructor
public class SwaggerConfig {
private final OpenApiExtensionResolver openApiExtensionResolver;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//加了ApiOperation注解的类,生成接口文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//包下的类,生成接口文档
.apis(RequestHandlerSelectors.basePackage("com.example.demo.transactional"))
.paths(PathSelectors.any())
.build()
.extensions(openApiExtensionResolver.buildExtensions("admin"))
.directModelSubstitute(java.util.Date.class, String.class)
//.securitySchemes(security())
;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("1")
.description("测试文档")
.termsOfServiceUrl("https://www.baidu.com")
.version("1.x")
.build();
}
}
三、controller中和实体类添加注解
四、页面访问
http://localhost:8888/doc.html