Swagger2 自动生成接口文档

最新推荐文章于 2024-08-09 10:02:55 发布

javafollowers

最新推荐文章于 2024-08-09 10:02:55 发布

阅读量1.9w

点赞数 2

分类专栏：自动生成api接口文档文章标签： Swagger2 api接口自动生成Api接口

本文链接：https://blog.csdn.net/haiming157/article/details/80661898

版权

本文介绍了如何在Spring Boot项目中集成Swagger2，通过注解方式自动化生成API接口文档，以提升开发效率并减少因文档更新不及时导致的问题。详细讲解了Swagger2的配置、控制器注解使用，以及如何通过Swagger2进行接口测试。

摘要由CSDN通过智能技术生成

为什么使用

公司服务器程序需要给移动端App等提供数据访问接口，之前接口信息都是使用word文档提供给前端人员使用，后来发现后台稍微修改一下，就需要更改一次文档，有时候修改不及时或者遗漏，容易造成前端和后台接口不一致，因此，后来决定尝试一下使用Swagger2来进行接口文档的描述。事实证明，这样的做法有利于工作效率的提高和前后台人员的沟通。

效果图

这里写图片描述

本次demo是使用Spring boot来做的，好处是搭建快，使用传统的方式跟这个差不多。

在pom.xml中添加依赖

 <!--  引入swagger包 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>