swagger2注解使用(swagger请求参数注解)

swagger2注解使用(swagger请求参数注解)用在请求的类上 表示对类的说明 常用参数 其他参数 示例 用在请求的方法上 说明方法的用途 作用 常用参数 其他参数 示例 用在请求的方法上 表示一组参数说明 ApiImplicitP 用在

大家好,我是讯享网,很高兴认识大家。



用在请求的类上,表示对类的说明

常用参数:

 

讯享网

其他参数:

讯享网

示例:

 

用在请求的方法上,说明方法的用途、作用

常用参数:

讯享网

其他参数:

 

示例:

讯享网

用在请求的方法上,表示一组参数说明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

常用参数:

 

其他参数:


讯享网

讯享网

示例:

 

用在请求的类上,表示对类的说明

用于响应类上,表示一个返回响应数据的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)

@ApiModelProperty:用在属性上,描述响应类的属性

常用参数:

讯享网

其他参数:

 

示例:

讯享网

private static final long serialVersionUID = 1L;

/

  • 用户名 */ @ApiModelProperty(value="用户名") private String account;

/

  • 密码 */ @ApiModelProperty(value="密码") private String password;

用在请求的方法上,表示一组响应

@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息

常用参数:

 

示例:

讯享网

用在请求方法中,描述参数信息

常用参数:

 

其他参数:

讯享网

示例:

 

或以实体类为参数:

@ResponseBody @PostMapping(value=“/login”) @ApiOperation(value = “登录检测”, notes=“根据用户名、密码判断该用户是否存在”) public UserModel login(@ApiParam(name = “model”, value = “用户信息Model”) UserModel model){}

小讯
上一篇 2025-05-15 07:34
下一篇 2025-04-17 16:02

相关推荐

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