由来

无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端常常埋怨后端给的接口文档与理论状况不统一。后端又感觉编写及保护接口文档会消耗不少精力，常常来不及更新。其实无论是前端调用后端，还是后端调用后端，都冀望有一个好的接口文档。

简介

• Swagger 是一个标准且残缺的框架，用于生成、形容、调用和可视化 RESTful 格调的 Web 服务。
• Swagger 的指标是对 REST API 定义一个规范且和语言无关的接口，能够让人和计算机领有毋庸拜访源码、文档或网络流量监测就能够发现和了解服务的能力。当通过 Swagger 进行正确定义，用户能够了解近程服务并应用起码实现逻辑与近程服务进行交互。与为底层编程所实现的接口相似，Swagger 打消了调用服务时可能会有的猜想。
• 后盾人员，无需关注 Swagger 形容文件和接口文档，有需要变更导致接口变动，间接写代码就好了。把调用层的代码做个批改，而后生成新的形容文件和接口文档后，给到前端即可。真正做到了一劳永逸。

实现代码和接口文档的一致性流程

劣势

• 反对 API 主动生成同步的在线文档：应用 Swagger 后能够间接通过代码生成文档，不再须要本人手动编写接口文档了，对程序员来说十分不便，能够节约写文档的工夫去学习新技术。
• 提供 Web 页面在线测试 API：Swagger 生成的文档还反对在线测试。参数和格局都定好了，间接在界面上输出参数对应的值即可在线测试接口。