Swagger接口文档

本文是一篇Swagger接口文档相关的学习笔记。

前端开发只要会用Swagger UI就行，不用懂太多配置（本文没写）上的事。

Swagger 解决了前后端开发的接口沟通问题，后端开发不用手动写接口文档，前端开发看Swagger生成的标准化文档也省了不少事情。尤其是可以线上测试接口，不用等开发中边写边测边调浪费时间。

相关概念

OpenAPI 简称OAS（OpenAPI 描述规范），制定通用的与语言无关的REST API 描述规范

RESTFUL是一种网络应用程序的设计风格和开发方式。

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

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

官网：https://swagger.io/

Swagger

围绕 OAS 构建 RESTFUL 文档

动态生成接口定义文档（基于代码生成文档）

接口功能测试（Swagger UI 可交互在线文档）

跨语言（支持 go, php, java, js, node）

易用免费开源

Swagger UI