Swagger注解

发布日期: 2022-06-28

更新日期: 2022-06-28

文章字数: 1.4k

阅读时长: 5 分

https://blog.csdn.net/jiangyu1013/article/details/83107255
https://www.cnblogs.com/h-c-g/p/11004020.html

Swagger2 JSON入参使用Map、JSONObject等非实体类接收时的处理

https://blog.csdn.net/x11819130/article/details/111608470
knife4j官方文档：
动态请求参数添加文档注释
https://doc.xiaominfo.com/knife4j/documentation/dynamicRequestDescription.html

需要不显示param为参数时可以使用@ApiIgnore注解

@AutoLog(value = "web首页-地图显示按行政区划")
@ApiOperation(value="web首页-地图显示按行政区划")
@ApiImplicitParams({@ApiImplicitParam(paramType = "query",name = "orgType",value ="行政等级",dataType ="String"),
                    @ApiImplicitParam(paramType = "header",name = "X-Access-Token",value ="token标记",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "firstFacilitiesId",value ="一级设施id",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "id",value ="区域id",dataType ="String"),
                    @ApiImplicitParam(paramType = "query",name = "leftLongitude",value ="地图左下经度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "leftLatitude",value ="地图左下纬度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "rightLongitude",value ="地图右上经度",dataType ="decimal"),
                    @ApiImplicitParam(paramType = "query",name = "rightLatitude",value ="地图右上纬度",dataType ="decimal")
         }
)
@GetMapping(value = "/circleCountByOrgType")
public Result<?> circleCountByOrgType(
        @ApiIgnore @RequestParam(required = false) Map param) {
    return Result.ok(mapList);
}

@ApiImplicitParam：
作用在方法上，表示单独的请求参数
参数：

name ：参数名。

value ：参数的具体意义，作用。

required ：参数是否必填。

dataType ：参数的数据类型。

paramType ：查询参数类型，这里有几种形式：

paramType 类型作用

path 以地址的形式提交数据

query 直接跟参数完成自动映射赋值

body 以流的形式提交仅支持POST

header 参数在request headers 里边提交

form 以form表单的形式提交仅支持POST

@ApiImplicitParams：
用于方法，包含多个 @ApiImplicitParam：
例：
@ApiOperation(“查询测试”)
@GetMapping(“select”)
//@ApiImplicitParam(name=“name”,value=“用户名”,dataType=“String”, paramType = “query”)
@ApiImplicitParams({
@ApiImplicitParam(name=“name”,value=“用户名”,dataType=“string”, paramType = “query”,example=“xingguo”),
@ApiImplicitParam(name=“id”,value=“用户id”,dataType=“long”, paramType = “query”)})
public void select(){
}

其他注解：


@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
    
    
    @ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"
    
    
    @ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    name：参数名
    value：参数的汉字说明、解释
    required：参数是否必须传
    paramType：参数放在哪个地方
    · header --> 请求参数的获取：@RequestHeader
    · query --> 请求参数的获取：@RequestParam
    · path（用于restful接口）--> 请求参数的获取：@PathVariable
    · body（不常用）
    · form（不常用）    
    dataType：参数类型，默认String，其它值dataType="Integer"       
    defaultValue：参数的默认值
    
    
    @ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如"请求参数没填好"
    response：抛出异常的类
    
    
    @ApiModel：用于响应类上，表示一个返回响应数据的信息
    （这种一般用在post创建的时候，使用@RequestBody这样的场景，
    请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

1、@Api：用在请求的类上，说明该类的作用
tags=“说明该类的作用”
value=“该参数没什么意义，所以不需要配置”
示例：
@Api(tags=“APP用户注册Controller”)
2、@ApiOperation：用在请求的方法上，说明方法的作用
@ApiOperation：“用在请求的方法上，说明方法的作用”
value=“说明方法的作用”
notes=“方法的备注说明”
示例：
@ApiOperation(value=“用户注册”,notes=“手机号、密码都是必输项，年龄随边填，但必须是数字”)
3、@ApiImplicitParams：用在请求的方法上，包含一组参数说明
@ApiImplicitParams：用在请求的方法上，包含一组参数说明
@ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一个请求参数的配置信息
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值
示列：
@ApiImplicitParams({ @ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”), @ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”), @ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)})
4、@ApiResponses：用于请求的方法上，表示一组响应
@ApiResponses：用于请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
示例：
@ApiOperation(value = “select1请求”,notes = “多个参数，多种的查询参数类型”)@ApiResponses({ @ApiResponse(code=400,message=“请求参数没填好”), @ApiResponse(code=404,message=“请求路径没有或页面跳转路径不对”)})

5、@ApiModel：用于响应类上，表示一个返回响应数据的信息
@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

示例:


import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{
    
    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
    
    /* getter/setter */