maven

  1. <!-- swagger3：访问路径http://ip:port/swagger-ui/index.html-->
  2. <dependency>
  3.     <groupId>io.springfox</groupId>
  4.     <artifactId>springfox-boot-starter</artifactId>
  5.     <version>3.0.0</version>
  6. </dependency>

常用注解

注解 说明
@Api 模块配置，用在Controller类上，描述Api接口
@ApiOperation 接口配置，用在方法上，描述接口方法
@ApiParam 方法参数配置，用在入参中或注解中
@Apilgnore 忽略此接口不生成文档
@ApiModel 用于类，表示对类进行说明，描述一个Model的信息
@ApiModelProperty 用于属性，表示对类中变量的说明，描述一个model的属性
@ApiImplicitParams 用在方法上包含一组参数说明
@ApiImplicitParam 用来注解来给方法入参增加说明
@ApiResponses 用于表示一组响应结果
@ApiResponse 用在@ApiResponses中，一般用于表达一个错误的响应信息