SpringBoot快速集成Swagger

本文介绍了如何在SpringBoot项目中快速集成Swagger,利用Swagger的文档注释和在线测试功能。通过添加依赖、配置类以及在Controller上使用注解,可以轻松生成API文档。在生产环境中,记得关闭Swagger以确保安全。
摘要由CSDN通过智能技术生成

 

Swagger的两个功能:文档注释、在线测试~

注意:生产版本发布后,关闭Swagger!!!

 

SpringBoot已经集成了Swagger,使用简单注解即可生成swagger的API文档。

 

0.Swagger常用注解说明


 @Api:修饰整个类,描述Controller的作用
 @ApiOperation:描述一个类的一个方法,或者说一个接口
 @ApiParam:单个参数描述
 @ApiModel:用对象来接收参数
 @ApiProperty:用对象接收参数时,描述对象的一个字段
 @ApiResponse:HTTP响应其中1个描述
 @ApiResponses:HTTP响应整体描述
 @ApiIgnore:使用该注解忽略这个API
 @ApiError :发生错误返回的信息
 @ApiImplicitParam:一个请求参数
 @ApiImplicitParams:多个请求参数

 

1.引入依赖

<dependency>
    <groupId>io.springfox</groupId&
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值