Spring MVC利用Swagger2如何构建动态RESTful API详解

前言

本文主要给大家介绍了关于spring mvc用swagger2构建动态RESTful api的相关内容，当多终端（WEB/移动端）需要公用业务逻辑时，一般会构建 RESTful 风格的服务提供给多终端使用。

为了减少与对应终端开发团队频繁沟通成本，刚开始我们会创建一份 RESTful API 文档来记录所有接口细节。

但随着项目推进，这样做所暴露出来的问题也越来越严重。

      a. 接口众多，细节复杂（需考虑不同的 Http 请求类型、HTTP 头部信息、HTTP 请求内容..），高质量地创建这份文档本身就是件非常吃力的事。

      b. 不断修改接口实现必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。

基于此，项目组在早些时间引入了 Swagger，经过几个项目的沉淀，确实起到了很不错的效果。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

服务的方法、参数、模型紧密集成到服务器端的代码，让维护文档和调整代码融为一体，使 API 始终保持同步。

本文主要描述 Swagger 与 springMVC 的集成过程以及遇到的一些问题，权当抛砖引玉只用，具体项目具体分析。

1. Maven 依赖和最简配置

<!--restfull APi swagger2-->  <dependency>   <groupId>io.springfox</groupId>   <artifactId>springfox-swagger2</artifactId>   <version>${swagger.version}</version>  </dependency>  <dependency>   <groupId>io.springfox</groupId>   <artifactId>springfox-swagger-ui</artifactId>   <version>${swagger.version}</version>  </dependency>