swagger是目前开发环境下主流的一种接口测试工具,并且可以生成swagger文档,省去了接口文档的操心事,当初这只能测试环境下用,上生产的时候我们可以选择不启用。
swagger2基本配置
上来第一步,导入依赖。
<!-- 加在上面的properties里 -->
<properties>
<swagger.version>2.9.2</swagger.version>
<swagger-models.version>1.5.21</swagger-models.version>
</properties>
<!-- swagger2相关依赖 -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>${swagger-models.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
然后写一个swaggerConfig配置一下swagger。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi(Environment environment) {
// 设置要显示swagger的环境
Profiles of = Profiles.of("dev", "local");
// 判断当前是否处于该环境
// 通过 enable() 接收此参数判断是否要显示
boolean b = environment.acceptsProfiles(of);
return new Docket(DocumentationType.SWAGGER_2)
.enable(b)
.pathMapping("/")
.select()
//扫描范围
.apis(RequestHandlerSelectors.basePackage("com.boot.controller"))
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("标题")
.description("描述")
.version("版本1.0")
.license("执照")
.licenseUrl("自家的地址")
.build());
}
}
当我上面的配置为dev,而没有local时,启动配置local的环境,就无法查看。如果把local加进去上面的配置中,就可以正常显示
生成文档
对了,文档并不是说给你生成一份word,而是这个页面就是api文档了,到时候直接把地址甩给你的前端即可,不过最好是甩个服务器上跑的项目的swagger,而不是你本地的
版权声明:本文为weixin_45369440原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。