最後更新：
Click to expand / collapse
為了使API易於理解，實施和維護，高質量的文檔很重要。我們使用Swagger UI和Redoc（兩個最流行的API渲染工具）配置基於OpenAPI規範的自動文檔生成。
這為開發人員提供了一個交互式界面，您可以在其中研究方法結構，測試查詢並快速連接到您的API。
文檔中包含的內容
| 章節 | 說明說明 |
|---|---|
| Endpoint 's和方法 | 路由完整列表、HTTP方法、參數、標題 |
| 查詢/回復示例 | curl、Postman、JavaScript、Python和其他語言的腳本 |
| 授權授權 | 直接從界面支持JWT, OAuth2, API Key |
| 對象圖 | 描述模型、嵌套結構和數據要求 |
| 錯誤代碼 | 帶有解釋的所有可能狀態 |
我們使用的工具
Swagger UI-具有測試功能的交互式瀏覽器文檔
Redoc是一個可讀、靜態的界面,非常適合在網站上發布
OpenAPI 3.0/3.1-規範格式,以構建所有內容
自動生成代碼-自動註釋、說明、版本和文檔更新
導出到JSON/YAML/HTML
為團隊和合作夥伴帶來的好處
加快新開發人員的步伐
減少集成中的錯誤
始終是最新、與代碼同步的文檔
無需技術支持即可快速啟動集成
在公共或私人門戶網站上輕松發布文檔
在哪裏，特別重要
面向外部開發人員的開放API
具有主動開發的內部API
具有B2B集成和SDK的平臺
需要法規和計劃驗證的服務