当前位置:网站首页 > R语言数据分析 > 正文

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



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

常用参数:

 
  

其他参数:

 
  

示例:

 
  

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

常用参数:

 
  

其他参数:

 
  

示例:

 
  

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

@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){}

到此这篇swagger2注解使用(swagger请求参数注解)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!

版权声明


相关文章:

  • 485报文怎么抓取(rs485报文)2025-11-02 10:45:07
  • docker-ce版本(docker-ce版本怎么看)2025-11-02 10:45:07
  • redhat修改root密码命令(redhat7修改root密码)2025-11-02 10:45:07
  • argry怎么读(arguing怎么读英语)2025-11-02 10:45:07
  • 删除双系统后 grub(双系统删除一个后)2025-11-02 10:45:07
  • argparse模块详解(arcsence模块的主要功能)2025-11-02 10:45:07
  • beyondcompare比较文件夹差异(beyondcompare对比文件夹)2025-11-02 10:45:07
  • ifstream读取文件路径(ifstream 路径)2025-11-02 10:45:07
  • hprof文件怎么分析线程(hprof文件用什么打开)2025-11-02 10:45:07
  • rmp是什么意思?(rmp是什么意思重庆)2025-11-02 10:45:07
  • 全屏图片