springBoot项目整合Swagger2

最新推荐文章于 2024-09-13 22:23:10 发布

原创

最新推荐文章于 2024-09-13 22:23:10 发布 · 400 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#springBoot #Swagger

本文档介绍了如何在SpringBoot项目中整合Swagger2，用于生成RESTful API接口文档。详细步骤包括添加依赖、配置Swagger2、使用注解装饰接口，并解决了版本过高导致页面不显示的问题。

springBoot项目整合Swagger2

swagger版本号：2.9.2

swagger是什么

官方说法：Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步

目前小咸儿做的项目是前后端分离的，为了更好的进行调试，所以后端需要提供一个API接口文档，这样开发起来更加的方便快捷。

springBoot和swagger进行整合

第一步：在pom.xml文件中引入jar包

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
 </dependency>

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