swagger是干什么用的（swagger是干嘛用的）



@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 指定对相应类型定义的引用，覆盖指定的任何参数值

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/45813.html