SpringBoot快速集成Swagger

最新推荐文章于 2024-01-26 20:06:33 发布

原创

最新推荐文章于 2024-01-26 20:06:33 发布 · 348 阅读

0 ·

CC 4.0 BY-SA版权

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

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>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.sprin