一分钟完成springboot项目整合Swagger2实现自动生成接口文档

发布网友发布时间：2022-11-30 13:00

共1个回答

热心网友时间：2023-06-27 17:38

一份好的接口文档能够让接口调用者很清晰的知道如何调用一个API接口，包括请求方式、传参规范、接口返回信息等；也能帮助团队新人快速了解业务。

传统的做法是由开发人员维护一个API接口文档，一般是一个word文档或一个提供接口文档管理的网站。这种做法有很多弊端：文档难以维护、浪费开人员时间、文档难以与接口保持一致等。

Swagger2的出现很好的解决了上述问题，可以实现接口文档实时在线生成，提供在线接口测试功能。唯一的弊端就是对接口程序有侵入，但本人认为还是利大于弊的。

接下来我们将Swagger2整合到springboot项目中，并用swagger-bootstrap-ui对Swagger2进行界面美化，废话不多说，我们开始。。。

在pom.xml中导入

在application.yml中设置swagger2是否开启的开关，关闭后接口文档被关闭，在生产环境部署时就需要关闭接口文档。

1.创建注解SwaggerCustomIgnore.java，主要用于忽略某些不想生成接口文档的接口。

2.创建配置类SpringfoxSwagger2Config.java，配置Swagger接口文档生成规则和过滤规则。

3.*排除swagger相关资源，新建或修改WebConfig.java文件，内容如下。

1.编写内容参考如下

2.注解说明

启动项目，浏览器输入http://location:8081/doc.html,效果如下。