在 Rest 接口或类上和 @ApiResponses 组合使用,组装返回参数说明
描述操作的可能响应,这可用于描述 Rest API 调用中可能的成功和错误 code 码。此注解可以在方法或类级别应用;仅当在方法级别或抛出时未定义相同代码的@ApiResponse注解时才会解析类级别注解异常,如果响应中使用了不同的响应类,则可以通过将响应类于响应码组合使用。注意swagger不允许单个响应代码的多个响应类型。此注解不直接使用,单独使用时swagger不会解析,应该和ApiResponses组合使用。
处理效果第一步,控制层加上注解 @ApiResponses({ @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class), })第二步,实体类属性上面加上注解@ApiModelProperty(value = "姓名", required = true)...
@GetMapping("/getStudentLoseList")
@ApiImplicitParams({
@ApiImplicitParam(paramType = "query", name = "type", value = "类型(0:取消分班 1:流失)",required = true,dataType = "int"),
@ApiImplicitParam(paramType = "query".
tags=“说明该类的作用,可以在UI界面上看到的注解”
value=“该参数没什么意义,在UI界面上也看到,所以不需要配置”
4@ApiOperation:用在请求的方法上,说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImpl...
目录SpringBoot中配置SwaggerSwagger常用注解测试注解用途用实体类接收参数或者返回数据配置
SpringBoot中配置Swagger
1. 导入依赖
官方推荐里说只需要前面两个依赖就可以了,但实测只导入上面两个依赖的话,后台会报依赖,网上查询加上下面两个依赖后不报异常了,原因未知。
<dependency>
<groupId>io.spring...
Swagger是个测试工具,它能将我们在controller层暴露的接口添加说明。
给类和方法添加说明描述
一.我们可以使用@Api注解,在一个controller类上添加说明。
那么,访问swagger时,就能看到这个controller类的描述了
二.我们可以通过将@ApiOperation注解,写在controller层的方法上,来说明该方法的作用。
给实体类的字段添加描述。
我们可以给实体类的字段添加描述。
那么,我们为什么要给实体类的属性添加描述呢?
这是因为在开发中,我们的con
Whatthehell?没得注释?查看当前自动生成的swagger代码如下:
首先,我们需要对需要注释的地方,添加xml文档。右键项目属性,生成下面,对XML文档进行打钩,会自动生成一个xml文档。
然后右键项目,生成以后,项目下面多出一个xml文件,右键xml文件到属性,选择始终...
1. @Api:用于描述整个API的信息,包括API的名称、描述、作者等。
2. @ApiOperation:用于描述API的操作,包括API的名称、描述、请求方式、请求参数、响应参数等。
3. @ApiParam:用于描述API的请求参数,包括参数名称、参数类型、参数描述等。
4. @ApiModel:用于描述数据模型,包括模型名称、模型属性等。
5. @ApiModelProperty:用于描述数据模型的属性,包括属性名称、属性类型、属性描述等。
6. @ApiResponse:用于描述API的响应信息,包括响应状态码、响应描述等。
7. @ApiResponses:用于描述API的多个响应信息。
以上注释的含义可以在Swagger文档中查看,也可以在Swagger UI中查看。