第6章 集成Swagger文档

Spring Boot作为当前最为流行的Java Web开发脚手架,越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的Web端(B/S),也会服务于移动端。在实际开发过程中,这些接口还要提供给开发测试进行相关的白盒测试,那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。假如你已经对传统的WIKI文档共享方式所带来的弊端深恶痛绝,那么不妨尝试一下Swagger2方式,一定会让你有不一样的开发体验。

使用Swagger集成文档具有以下几个优势:

  • 功能丰富:支持多种注解,自动生成接口文档界面,支持在界面测试API接口功能。
  • 及时更新:开发过程中花一点写注释的时间,就可以及时地更新API文档,省心省力。
  • 整合简单:通过添加pom依赖和简单配置,内嵌于应用中就可同时发布API接口文档界面,不需要部署独立服务。

官方网站:https://swagger.io/

官方文档:https://swagger.io/docs/