- @Api 用在请求类上,表示对类的说明
- tags = "说明该类的作用,可以在UI洁面霜行看到的注解"
- value = "该参数没什么意义,在UI界面上也看到,所以不需要配置”
- @ApiOperation:用在请求的方法上,说明方法的用途 作用
- value:说明方法的用途,作用(此说明再xxx-controller下,点击才能看到)
- notes:方法的备用说明 (当有此值时:该接口说明会到页面中的主界面上)
- tags:此参数不应该用到方法上,不然会在首页中独立展示为一个接口,这个接口与存在在controller文件中的接口描述相同,冗余
- @ApiImplicitParams:用在请求的方法上,表示一组参数说明
- @ApiImplictParam:用在@ApliImplicitParams 注解中,指定一个请求参数的各个方面
- name:参数名
- value:参数的汉字说明。
- required:是否必传
- paramType:参数类型(参数放置的位置)
- header:请求参数的获取 @RequestHeader
- query : 请求参数的获取 @RequestParam
- path :用于Restful接口,请求参数的获取@PathVariable
- body (不常用)
- form(不常用)
- dataType:参数类型。默认String,其他值DataType = “Integer”
- defaultValue:参数的默认值
- @ApiImplictParam:用在@ApliImplicitParams 注解中,指定一个请求参数的各个方面
- @ApiResponses:用在请求的方法上,表示一组响应
- @ApiResponse:用在@APIResponses中,一般用于表达一个错误的响应信息
- code:数字,例如400
- message:信息,例如“请求参数没有填好”
- response:抛出异常的类
- @ApiResponse:用在@APIResponses中,一般用于表达一个错误的响应信息
- @ApiModel:用于响应类上,表示一个返回响应数据的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
- @ApiModelProperty:用在属性上,描述响应类的属性
- @ApiIgnore 忽视方法(不在UI界面上展示这个方法)
Swagger2 注解
猜你喜欢
转载自blog.csdn.net/m0_37626203/article/details/85094864
今日推荐
周排行