swagger2注解说明文档

本文档详细介绍了Swagger2的配置步骤以及如何在API中使用注解进行接口文档的生成,帮助开发者快速理解和应用Swagger2来提升API文档的管理和开发效率。
摘要由CSDN通过智能技术生成
注解 属性 说明
@Api 用于类上,说明该类的作用。可以标记一个controller类作为swagger的文档资源
value url的路径
tags 如果设置这个值,value的值会被覆盖
description 对Api资源的描述
basePath 基本路径,可以不用配置
position 设置多个Api显示的顺序位置
produces For example, “application/json, application/xml”
consumes For example, “application/json, application/xml”
protocols Possible values: http, https, ws, wss.
authorizations 高级特性认证时配置
hidden 配置为true 将在文档中隐藏
@ApiOperation 用于方法上,说明方法的作用,每一个url资源的定义
valu
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 8
    评论
评论 8
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值