| 注释类型 | 说明 |
|---|---|
| ApiController |
Controller 说明
|
| ApiEnum |
Enum 类型字段描述,不可用于泛型,集合中
|
| ApiField |
字段说明
|
| ApiHeaderCancel |
用来表示该方法请求不需要请求头,为空,代表取消全部。
|
| ApiIgnore |
扫描忽略,不会被显示到文档上,但校验还是存在。
|
| ApiMethod |
限制只能用于方法上,接口说明
|
| ApiParam |
用于描述 字段,配置校验等信息
|
| ApiParamIgnore |
需要隐藏的字段,为空表示,只留下被 ApiParam 标识的字段,
支持 * 号匹配,只能用于前面或后面如: a_*.
|
| ApiParams |
ApiParam 的注解组,不推荐使用,
请直接使用 ApiParam 多重注解方式。
|
| ApiResponse |
用于描述 返回值 字段
|
| ApiResponseCode |
用户于配置Api返回code信息,只显示会返回的code信息
|
| ApiResponseIgnore |
需要隐藏的参数,为空表示,只留下被 ApiResponse 标识的字段
支持 * 号匹配,只能用于前面或后面如: a_*.
|
| ApiResponses |
ApiResponse 注解组,不推荐使用,
请直接使用 ApiResponse 多重注解方式,
即直接在在方法写多个 ApiResponse 注解。
|
Copyright © 2024. All rights reserved.