Swagger:它可以自动检查您的类,检测控制器,它们的方法,它们使用的模型类以及它们映射到的URL。没有任何手写文档,只需检查应用程序中的类,它就可以生成大量有关API的信息
集成步骤
一、添加依赖
在pom.xml中,添加swagger依赖
<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>
二、配置类
新建config包,在包下添加Swagger配置类SwaggerConfig.java
在类上添加@EnableSwagger2、@Configuration注解
在createRestApi方法上添加@Bean注解
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder().build();
}
}
到此,我们已经配置完成,启动项目,访问http://localhost:8001/swagger-ui.html#/
接口文档已生成,我们也可以点击Try it out -----EXECUTE进行测试
配置完swagger,在后续的开发中我们可以通过它来测试