关于Swagger优点，官网了解：https://swagger.io/ ，俺这里就不bb了。
SpringBoot集成Swagger2比较简单。楼主这里也是自个儿记录下，下次再用直接看这里了，不然每次都要找…(找啊找啊找朋友…)。
一、引入Swagger需要的Maven依赖
<!--集成swagger2-->
<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>
二、定义swagger配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//只有加了ApiOperation注解的类，才生成接口文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
// 都生成
// .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SoDo")
.description("sodo-api文档")
.build();
}
}
三、自定义文档说明
- 类上方：说明下，这个类中是哪些接口的Api。 如：@Api(tags = “User相关接口”, description = “提供User相关的 Rest API”)
- 方法上方：说明下，这个方法是用来做什么的。 如：@ApiOperation(value = “注册用户”)
到这里就可以了，启动项目访问：http://localhost:8080/swagger-ui.html#/，就可以看到Swagger ui Api了（我这里端口号8080哈）。
点开具体某个接口api，可根据参数定义发送请求。如下登录：
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/115777.html
