IT评测·应用市场-qidao123.com

标题: SpringBoot整合Swagger-UI接口文档 [打印本页]
作者: 张春    时间: 2025-3-20 14:42
标题: SpringBoot整合Swagger-UI接口文档
SpringBoot整合Swagger-UI接口文档

Swagger-UI好处

Swagger-UI常用注解先容

@Api：用于修饰Controller类，生成Controller相干文档信息
@ApiOperation：用于修饰Controller类中的方法，生成接口方法相干文档信息
@ApiParam：用于修饰接口中的参数，生成接口参数相干文档信息
@ApiModelProperty：用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相干文档信息
整合步骤

1、maven中添加依赖
  1.    
  2.     <dependency>
  3.       <groupId>io.springfox</groupId>
  4.       <artifactId>springfox-swagger2</artifactId>
  5.       <version>2.7.0</version>
  6.     </dependency>
  7.     <dependency>
  8.       <groupId>io.springfox</groupId>
  9.       <artifactId>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

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 IT评测·应用市场-qidao123.com (https://dis.qidao123.com/) Powered by Discuz! X3.4