Swagger-UI 在线文档(单包扫描,多包扫描,多微服务扫描)

Swagger-UI是HTML, Javascript, CSS的一个集合,可以动态地根据注解生成在线API文档。

常用注解:

  •  @Api:用于修饰Controller类,生成Controller相关文档信息
  • @ApiOperation:用于修饰Controller类中的方法,生成接口方法相关文档信息
  • @ApiParam:用于修饰接口中的参数,生成接口参数相关文档信息
  • @ApiModelProperty:用于修饰实体类的属性,当实体类是请求参数或返回结果时,直接生成相关文档信息

(1)在pom.xml添加依赖

<!--Swagger-UI API文档生产工具-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.7.0</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.7.0</version>
</dependency>

(2)Spring boot 2.2.5配置

@EnableWebMvc
@Configuration
@EnableSwagger2
@ComponentScan(basePackages = "com.wxw.controller"

猜你喜欢

转载自blog.csdn.net/qq_41893274/article/details/104862141