springboot 整合swagger2 ，搭建 RESTful API 在线文档

￡神魔★判官ぃ 2022-03-26 08:36 321阅读 0赞

1、pom 文件引入jar包

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>

2、生成文档的注释

swagger2 通过注解来生成api接口文档，文档信息包括接口名、请求方法、参数、返回信息等。

注解：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>@Api</td> 
   <td> <p>修饰整个类，用于描述Controller类</p> </td> 
  </tr> 
  <tr> 
   <td> <p>@ApiOperation</p> </td> 
   <td>描述类的方法，或者说是一个接口</td> 
  </tr> 
  <tr> 
   <td>@ApiParam</td> 
   <td>单个参数描述</td> 
  </tr> 
  <tr> 
   <td>@ApiModel</td> 
   <td>用对象来接受参数</td> 
  </tr> 
  <tr> 
   <td>@ApiProperty</td> 
   <td>用对象接收参数时，描述对象的一个字段</td> 
  </tr> 
  <tr> 
   <td>@ApiResponse</td> 
   <td>HTTP响应的一个描述</td> 
  </tr> 
  <tr> 
   <td>@ApiResponses</td> 
   <td>HTTP响应的整体描述</td> 
  </tr> 
  <tr> 
   <td>@ApiIgnore</td> 
   <td>忽略这个api</td> 
  </tr> 
  <tr> 
   <td>@ApiError</td> 
   <td>发生错误返回的信息</td> 
  </tr> 
  <tr> 
   <td>@ApiParamImplicit</td> 
   <td>一个请求参数</td> 
  </tr> 
  <tr> 
   <td>@ApiParamsImplicit</td> 
   <td>多个请求参数</td> 
  </tr> 
 </tbody> 
</table>

发表评论取消回复

表情：

评论列表（有 0 条评论，321人围观）

还没有评论，来说两句吧...

相关阅读

相关 SpringBoot整合Swagger2 API文档

使用SpringBoot 整合 Swagger2 ，配置 Swagger2 生成 API 接口文档。

╰半橙微兮°/ 2024年04月23日 20:07/ 0 赞/ 82 阅读

相关 SpringBoot整合swagger2进行API文档编程

*1. 添加依赖**  <dependency> <groupId>io.springfox</gr...

秒速五厘米/ 2024年04月18日 03:27/ 0 赞/ 61 阅读

相关 springboot整合Swagger在线文档

SpringBoot整合Swagger2在线文档一什么是swagger？我们前面有讲到说开发时会创建Restful风格的API接口，供第三方或前端人员

r囧r小猫/ 2024年03月31日 17:19/ 0 赞/ 86 阅读

相关 SpringBoot 项目配置 Swagger 接口api 搭建 REST

一、简述开发前后端分离架构的项目，往往调试后端Web接口需要用到POSTMAN工具。虽然POSTMAN工具的功能非常强大，但是请求参数很多的情况下，我们手写这些参数和数据

小鱼儿/ 2023年01月19日 07:06/ 0 赞/ 7 阅读

相关 SpringBoot整合Swagger2生成接口API文档

前言：Swagger2是一个能够帮助我们快速生成RESTful接口API文档的一个工具，你可以在控制器上写上接口描述，参数描述等等，在生成的Swagger2接口文档中都有体现，

r囧r小猫/ 2022年12月07日 12:08/ 0 赞/ 287 阅读

相关 springboot集成Swagger2构建RESTful API文档

什么是Swagger2 可以自行百度了解 Swagger2提供了什么能力随项目自动生成强大RESTful API文档，减少工作量 API文档与代码整

分手后的思念是犯贱/ 2022年05月16日 00:15/ 0 赞/ 329 阅读

相关 Springboot项目整合swagger2在线API文档

由于Spring Boot能够快速开发、便捷部署等特性，相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常

我会带着你远行/ 2022年04月01日 12:46/ 0 赞/ 413 阅读

相关 Spring Boot整合Swagger2搭建在线文档

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 Restfull 风格的 Web 接口服务，在当前前后端分离的情况下，利用swagger搭建一

梦里梦外;/ 2022年03月30日 14:50/ 0 赞/ 316 阅读

相关 springboot 整合swagger2 ，搭建 RESTful API 在线文档

1、pom 文件引入jar包 <dependency> <groupId>io.springfox</groupId>

￡神魔★判官ぃ/ 2022年03月26日 08:36/ 0 赞/ 322 阅读

相关 SpringBoot整合Swagger2--搭建RestfulAPI在线文档

Swagger Swagger,中文“拽"的意思，它是一个功能强大的在线API文档的框架，目前它的版本为2.x,所以称为Swagger2。 Swagger2提供了在线文

阳光穿透心脏的1/2处/ 2021年08月29日 14:43/ 0 赞/ 442 阅读