swagger注解

最新推荐文章于 2024-01-16 16:09:53 发布

想了好久才取了这

最新推荐文章于 2024-01-16 16:09:53 发布

阅读量588

点赞数

文章标签： java 开发语言

本文链接：https://blog.csdn.net/qq_39940489/article/details/125477182

版权

本文介绍了Swagger中常用的注解，包括@Api、@ApiOperation、@ApiParam、@ApiImplicitParam等，详细解析了各注解的作用和参数，帮助理解如何使用这些注解来构建API文档。

摘要由CSDN通过智能技术生成

常用注解：

@Api(description = “接口类的描述”)
@ApiOperation(value = “接口方法的名称”, notes = “备注说明”)
@ApiParam(name = “参数名称”, value = “备注说明”, required = 是否必须)：标注在方法的参数上用于描述参数的名称、备注、是否必须等信息
@ApiImplicitParam(paramType = “query”, name = “password”, dataType = “String”, required = true, value = “密码”, defaultValue = “123456”)用于描述方法的参数，标注在方法上，和@ApiParam功能一样，只是标注的位置不同而已
.paramType：参数类型，即参数放在哪个地方
. header–>请求参数的获取：@RequestHeader，参数放在请求头
. query–>请求参数的获取：@RequestParam，参数追加在url后面
. path（用于restful接口）–>请求参数的获取：@PathVariable
. body 使用@RequestBody接收数据 POST有效，参数放在请求体中
. form
.name：参数名
.dataType：参数的数据类型
.required：参数是否必须传
.value&