常用注解注解说明常用属性属性说明类注解,常用来给文档中的控制器取别名tags别名方法/类注解,常用来描述方法value
notes方法说明
方法备注参数/方法/属性注解,常用来描述参数name
value
required参数名
补充描述
是否必须方法/属性注解,使被标注方法不生成文档--方法注解,描述一个参数name
value
name
required
paramType
dataType
defaultValue参数名
补充说明
是否必传
参数位置(header、query、path)
参数类型(默认 String)
默认值搭配 @ApiImplicitParam 一起使用,描述一组参数
讯享网方法注解,表达一个错误的响应信息code
message
response整型
字符串
异常信息(默认 String 类型)搭配 @ApiResponse 一起使用,参考 @ApiImplicitParams类注解,当此实体类被作为返回类型用于 API 帮助文档中的接口方法中,此注解被解析value
description实体类名
补充描述属性注解,搭配 @ApiModel 使用value
example
hidden属性名
示例
是否隐藏

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/190934.html