Swagger GithubAPI注解说明:Go
Swagger 官网:Go
Swagger 编辑器 Go
示例代码请访问 GO
API注解使用方式
Name | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@Api | 用在请求的类上,表示对类的说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||
tags | "说明该类的作用,可以在UI界面上看到的注解" | |||||||||||||||||||||||||||||||||||||||||||||||||||
value | "该参数没什么意义,在UI界面上也看到,所以不需要配置" | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiImplicitParam | 用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
| |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiImplicitParams | 用在请求的方法上,表示一组参数说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiModel | 用于响应类上,表示一个返回响应数据的信息 (这种一般用在post创建的时候,使用@RequestBody这样的场景, | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiModelProperty | 用在属性上,描述响应类的属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiOperation | 用在请求的方法上,说明方法的用途、作用 | |||||||||||||||||||||||||||||||||||||||||||||||||||
value | "说明方法的用途、作用" | |||||||||||||||||||||||||||||||||||||||||||||||||||
notes | "方法的备注说明" | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiParam | 用在@ApiImplicitParams的方法里边,定义接收的参数形式 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiResponse | 用在@ApiResponses中,一般用于表达一个错误的响应信息 | |||||||||||||||||||||||||||||||||||||||||||||||||||
code | 数字,例如400 | |||||||||||||||||||||||||||||||||||||||||||||||||||
message | 信息,例如"请求参数没填好" | |||||||||||||||||||||||||||||||||||||||||||||||||||
response | 抛出异常的类 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ApiResponses | 用在请求的方法上,表示一组响应 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@Authorization | 声明要在资源或操作上使用的授权方案。 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@AuthorizationScope | 描述OAuth2授权范围。 | |||||||||||||||||||||||||||||||||||||||||||||||||||
@ResponseHeader | 表示可以作为响应的一部分提供的标头。 |