最后更新：
Click to expand / collapse
要快速且易于理解的API集成,需要结构化的文档。我们使用OpenAPI 3规范。0+（以前称为Swagger），它允许以单一标准化格式描述所有API方法，参数和模型，并具有代码生成，测试和导出SDK的功能。
这降低了开发人员的登录阈值，加快了集成，并消除了与不完整或过时的接口描述相关的错误。
OpenAPI/Swagger给出的内容
| 一个机会 | 优点 |
|---|---|
| 交互式文档 | Swagger UI能够在浏览器中直接测试API |
| SDK生成 | 自动创建不同语言的客户端库 |
| 按标准排列的结构 | 描述所有残局、参数、答桉、错误和授权 |
| 机器可读性 | API可以验证、蒸发、导出和连接到CI/CD |
| 相关性 | 文档在API更改时自动更新 |
如何实现
OpenAPI 3格式的API说明。0（.yaml或。json)
能够生成Postman集合和SDK （cURL, JS, PHP, Python, Java和Go）
授权支持： API key, JWT, OAuth2
可视化显示可用查询和可能的响应
直接从文档中测试API （Swagger UI/Redoc）
对开发人员的好处
快速连接而无需手动分析结构
支持IDE和代码生成器（Swagger Codegen, OpenAPI Generator）
文档始终与当前的API匹配
方便传输给合作伙伴和集成商
改进DX（开发者体验）和实施速度
在哪里，特别重要
具有开放或公共API的项目
从事API优先方法的团队
具有外部集成和合作伙伴连接的平台
使用后端API的移动和前端应用程序