Swagger2

Posted 2021-02-20 shangyunlin

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Swagger2相关的知识，希望对你有一定的参考价值。

引入依赖

<dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-common</artifactId>
          <version>2.7.0</version>
      </dependency>
      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>2.7.0</version>
      </dependency>
      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>2.7.0</version>
      </dependency>

springboot整合

添加@EnableSwagger2

使用

Swagger 通过注解定制接口对外展示的信息，这些信息包括接口名、请求方法、参数、返回信息等。更多注解类型：

@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：描述一个请求参数，可以配置参数的中文含义，还可以给参数设置默认值
@ApiImplicitParams：描述由多个 @ApiImplicitParam 注解的参数组成的请求参数列表

访问http://localhost:9001/swagger-ui.html

以上是关于Swagger2的主要内容，如果未能解决你的问题，请参考以下文章

SpringBoot整合Swagger2

Swagger 2与OpenAPI 3