spring boot整合swagger2

Swagger GithubAPI注解说明:Go

Swagger 官网:Go

Swagger 编辑器  Go

示例代码请访问 GO

API注解使用方式

NameDescription
@Api

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

tags"说明该类的作用,可以在UI界面上看到的注解"
value"该参数没什么意义,在UI界面上也看到,所以不需要配置"
@ApiImplicitParam

                  用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

name参数名
value

参数的汉字说明、解释 

required参数是否必须传
dataType参数类型,默认String,其它值dataType="Integer"  
defaultValue参数的默认值
paramType参数放在哪个地方
header请求参数的获取@RequestHeader
query请求参数的获取@RequestParam
path请求参数的获取@PathVariable
body请求参数的获取@RequestBody
form普通表单提交
@ApiImplicitParams用在请求的方法上,表示一组参数说明
@ApiModel

用于响应类上,表示一个返回响应数据的信息

(这种一般用在post创建的时候,使用@RequestBody这样的场景,
 请求参数无法使用@ApiImplicitParam注解进行描述的时候)

@ApiModelProperty用在属性上,描述响应类的属性
@ApiOperation用在请求的方法上,说明方法的用途、作用
value"说明方法的用途、作用"
notes"方法的备注说明"
@ApiParam用在@ApiImplicitParams的方法里边,定义接收的参数形式
@ApiResponse用在@ApiResponses中,一般用于表达一个错误的响应信息
code数字,例如400
message信息,例如"请求参数没填好"
response抛出异常的类
@ApiResponses用在请求的方法上,表示一组响应
@Authorization声明要在资源或操作上使用的授权方案。
@AuthorizationScope描述OAuth2授权范围。
@ResponseHeader表示可以作为响应的一部分提供的标头。

  • 2
    点赞
  • 8
    收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:黑客帝国 设计师:我叫白小胖 返回首页
评论

打赏作者

花花世界芸芸众生

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值