1.添加maven依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.创建Swagger配置类
1.通过 @Configuration 让spring来加载该配置类
2.通过 @EnableSwagger2 来启动Swagger2
3.再通过createRestApi函数创建Docket的Bean之后,apiInfo() 用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描的包路径来定义,Swagger会扫描该包下所有Controller定义的API,并产生文档内容(除了被@ApiIgnore指定的请求)。
package com.innovation.config;
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;
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 配置api扫描包的一个范围
.apis(RequestHandlerSelectors.basePackage("com.innovation"))
.paths(PathSelectors.any())
.build();
}
/**
* 文档相关信息
* @return ApiInfo
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 文档标题
.title("auto api文档")
// 版本号
.version("1.0")
// 描述
.description("atong的api文档")
.build();
}
}
3.swagger注解使用
参考:
[1]https://blog.csdn.net/xiaojin21cen/article/details/78654652
[2]https://www.jianshu.com/p/f30e0c646c63
4.访问
项目启动后访问访 localhost:port/swagger-ui.html 即可
注意:port为你项目的端口例如8080