swagger 注解使用

Swagger是一个规范化的框架,用于构建、描述RESTful Web服务。本文详细介绍了Swagger的各种注解,包括@Api、@ApiModel、@ApiModelProperty、@ApiParam、@ApiOperation、@ApiResponse、@ApiImplicitParam和@ApiImplicitParams的使用方法,并提供了相应的截图示例。同时,文章提到了Swagger如何与Spring Boot集成的相关资源。
摘要由CSDN通过智能技术生成

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger的目标是对REST API定义一个标准的和语言无关的接口,可让人和计算机无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过Swagger进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger消除了调用服务时可能会有的猜测。

关于Swagger的集成请参考:https://github.com/yinjihuan/spring-boot-starter-swagger
##API
@Api 用在类上,说明该类的作用。可以标记一个Controller类做为swagger 文档资源,使用方式如下:

@Api(value="企业用户控制器", tags={"用户接口"})
@RestController
@RequestMapping("/user")
public class EnterpriseProductUserController {

}

效果图如下:

image.png

  • value:接口说明
  • tags:接口说明,可以在页面中显示。可以配置多个,当配置多个的时候,在页面中会显示多个接口的信息
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值