SpringBoot整合Swagger-UI接口文档

SpringBoot整合Swagger-UI接口文档

Swagger-UI好处

• Swagger-UI   一个好看又好用的项目接口文档，可以动态地根据注解生成在线API文档。也就是说和你代码的Controller层的接口方法对应，支持在线接口测试，不依赖第三方工具
  

Swagger-UI常用注解介绍

@Api：用于修饰Controller类，生成Controller相关文档信息

@ApiOperation：用于修饰Controller类中的方法，生成接口方法相关文档信息

@ApiParam：用于修饰接口中的参数，生成接口参数相关文档信息

@ApiModelProperty：用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息

整合步骤

1、maven中添加依赖

1.    
2.     <dependency>
3.       <groupId>io.springfox</groupId>
4.       springfox-swagger2</artifactId>
5.       <version>2.7.0</version>
6.     </dependency>
7.     <dependency>
8.       <groupId>io.springfox</groupId>
9.       springfox-swagger-ui</artifactId>
10.       <version>2.7.0</version>
11.     </dependency>

复制代码

2、项目中添加Swagger-UI配置类

这里参考github上mall项目的配置类

1. package com.macro.mall.tiny.config;
2. import org.springframework.context.annotation.Bean;
3. import org.springframework.context.annotation.Configuration;
4. import springfox.documentation.builders.ApiInfoBuilder;
5. import springfox.documentation.builders.PathSelectors;
6. import springfox.documentation.builders.RequestHandlerSelectors;
7. import springfox.documentation.service.ApiInfo;
8. import springfox.documentation.spi.DocumentationType;
9. import springfox.documentation.spring.web.plugins.Docket;
10. import springfox.documentation.swagger2.annotations.EnableSwagger2;
12. /**
13. * Swagger2API文档的配置
14. */
15. @Configuration
16. @EnableSwagger2
17. public class Swagger2Config {
18.     @Bean
19.     public Docket createRestApi(){
20.         return new Docket(DocumentationType.SWAGGER_2)
21.                 .apiInfo(apiInfo())
22.                 .select()
23.                 //为当前包下controller生成API文档
24.                 .apis(RequestHandlerSelectors.basePackage("com.macro.mall.tiny.controller"))
25.                 //为有@Api注解的Controller生成API文档
26.                 .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
27.                 //为有@ApiOperation注解的方法生成API文档
28.                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
29.                 .paths(PathSelectors.any())
30.                 .build();
31.     }
33.     private ApiInfo apiInfo() {
34.         return new ApiInfoBuilder()
35.                 .title("SwaggerUI文档")   
36.                 .description("某某某商城项目/系统后台所有接口文档")
37.                 .contact("macro")
38.                 .version("版本号1.0")
39.                 .build();
40.     }
41. }

复制代码

3、配合注解使用

在你要生成接口文档的Controller层的Class类上面添加@Api(tags = "msBrandController", description = "商品品牌管理")方法上面添加@ApiOperation("获取所有品牌列表")注解

4、查看效果

访问接口文档地址接口地址：http://localhost:8086/swagger-ui.html 查看效果

注意换成自己项目的端口号（application.yml中查看或者设置springboot项目端口），我这里使用的是8086端

参考：https://github.com/macrozheng/mall

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！