在Java类中添加Swagger的注解即可生成Swagger接口,常用Swagger注解如下:
在配置类中配置
swagger:
title: ""
description: ""
扫描的controller在哪个包
base-package:
enabled: true
version: 1.0.0
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口 、
@ApiParam:单个参数描述
@ApiModel:用对象来接收参数
@ApiModelProperty:用对象接收参数时,描述对象的一个字段
@ApiResponse:HTTP响应其中1个描述 @
ApiResponses:HTTP响应整体描述
@ApiIgnore:使用该注解忽略这个API
@ApiError :发生错误返回的信息
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数