这里只讲述@api、@apioperation、@apiimplicitparams、@apiimplicitparam、@apiparam、@apimodel、@apimodelproperty、apiresponses、@apiresponse这几个常用的。
@api：用在请求的类上，表示对类的说明
常用参数：
tags="说明该类的作用，非空时将覆盖value的值"
value="描述类的作用"
其他参数：
description 对api资源的描述，在1.5版本后不再支持
basepath 基本路径可以不配置，在1.5版本后不再支持
position 如果配置多个api 想改变显示的顺序位置，在1.5版本后不再支持
produces 设置mime类型列表（output），例："application/json, application/xml"，默认为空
consumes 设置mime类型列表（input），例："application/json, application/xml"，默认为空
protocols 设置特定协议，例：http， https， ws， wss。
authorizations 获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden 默认为false， 配置为true 将在文档中隐藏
示例：
@api(tags="登录请求")
@controller
@requestmapping(value="/highpregnant")
public class logincontroller {}
@apioperation：用在请求的方法上，说明方法的用途、作用
常用参数：
value="说明方法的用途、作用"
notes="方法的备注说明"
其他参数：
tags 操作标签，非空时将覆盖value的值
response 响应类型（即返回对象）
responsecontainer 声明包装的响应容器（返回对象类型）。有效值为 "list", "set" or "map"。
responsereference 指定对响应类型的引用。将覆盖任何指定的response（）类
httpmethod 指定http方法，"get", "head", "post", "put", "delete", "options" and "patch"
position 如果配置多个api 想改变显示的顺序位置，在1.5版本后不再支持
nickname 第三方工具唯一标识，默认为空
produces 设置mime类型列表（output），例："application/json, application/xml"，默认为空
consumes 设置mime类型列表（input），例："application/json, application/xml"，默认为空
protocols 设置特定协议，例：http， https， ws， wss。
authorizations 获取授权列表（安全声明），如果未设置，则返回一个空的授权值。
hidden 默认为false， 配置为true 将在文档中隐藏
responseheaders 响应头列表
code 响应的http状态代码。默认 200
extensions 扩展属性列表数组
示例：
@responsebody
@postmapping(value="/login")
@apioperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public usermodel login(@requestparam(value = "name", required = false) string account,
@requestparam(value = "pass", required = false) string password){}
@apiimplicitparams：用在请求的方法上，表示一组参数说明
@apiimplicitparam：用在@apiimplicitparams注解中，指定一个请求参数的各个方面
name：参数名，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value：参数的汉字说明、解释
required：参数是否必须传，默认为false [路径参数必填]
paramtype：参数放在哪个地方
· header --> 请求参数的获取：@requestheader
· query --> 请求参数的获取：@requestparam
· path（用于restful接口）--> 请求参数的获取：@pathvariable
· body（不常用）
· form（不常用）
datatype：参数类型，默认string，其它值datatype="integer"
defaultvalue：参数的默认值
示例：
@responsebody
@postmapping(value="/login")
@apioperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
@apiimplicitparams({
@apiimplicitparam(name = "name", value = "用户名", required = false, paramtype = "query", datatype = "string"),
@apiimplicitparam(name = "pass", value = "密码", required = false, paramtype = "query", datatype = "string")
})
public usermodel login(@requestparam(value = "name", required = false) string account,
@requestparam(value = "pass", required = false) string password){}
其他参数（@apiimplicitparam）：
allowablevalues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从api文档中过滤参数。
allowmultiple 指定参数是否可以通过具有多个事件接受多个值，默认为false
example 单个示例
examples 参数示例。仅适用于bodyparameters
@apimodel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@requestbody这样的场景，请求参数无法使用@apiimplicitparam注解进行描述的时候）
@apimodelproperty：用在属性上，描述响应类的属性
示例：
@apimodel(value="用户登录信息", description="用于判断用户是否存在")
public class usermodel implements serializable{
private static final long serialversionuid = 1l;
/**
* 用户名
*/
@apimodelproperty(value="用户名")
private string account;
/**
* 密码
*/
@apimodelproperty(value="密码")
private string password;
}
其他(@apimodelproperty)：
value 此属性的简要说明。
name 允许覆盖属性名称
allowablevalues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从api文档中过滤属性。
notes 目前尚未使用。
datatype 参数的数据类型。可以是类名或者参数名，会覆盖类的属性名称。
required 参数是否必传，默认为false
position 允许在类中对属性进行排序。默认为0
hidden 允许在swagger模型定义中隐藏该属性。
example 属性的示例。
readonly 将属性设定为只读。
reference 指定对相应类型定义的引用，覆盖指定的任何参数值
@apiresponses：用在请求的方法上，表示一组响应
@apiresponse：用在@apiresponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
示例：
@responsebody
@postmapping(value="/update/{id}")
@apioperation(value = "修改用户信息",notes = "打开页面并修改指定用户信息")
@apiresponses({
@apiresponse(code=400,message="请求参数没填好"),
@apiresponse(code=404,message="请求路径没有或页面跳转路径不对")
})
public jsonresult update(@pathvariable string id, usermodel model){}
@apiparam： 用在请求方法中，描述参数信息
name：参数名称，参数名称可以覆盖方法参数名称，路径参数必须与方法参数一致
value：参数的简要说明。
defaultvalue：参数默认值
required 属性是否必填，默认为false [路径参数必须填]
示例：
@responsebody
@postmapping(value="/login")
@apioperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public usermodel login(@apiparam(name = "name", value = "用户名", required = false) @requestparam(value = "name", required = false) string account,
@apiparam(name = "pass", value = "密码", required = false) @requestparam(value = "pass", required = false) string password){}
或以实体类为参数：
@responsebody
@postmapping(value="/login")
@apioperation(value = "登录检测", notes="根据用户名、密码判断该用户是否存在")
public usermodel login(@apiparam(name = "model", value = "用户信息model") usermodel model){}
其他：
allowablevalues 限制参数的可接受值。1.以逗号分隔的列表 2、范围值 3、设置最小值/最大值
access 允许从api文档中过滤参数。
allowmultiple 指定参数是否可以通过具有多个事件接受多个值，默认为false
hidden 隐藏参数列表中的参数。
example 单个示例
examples 参数示例。仅适用于bodyparameters
本文转载于爱吃醋的兔子
如对本文有疑问， 点击进行留言回复！！
【性能】Android中的内存溢出（Out Of Memory，OOM）
android framework层input事件接收和派发
我要评论
网友评论