文檔生成（Swagger，Redoc）

文檔生成（Swagger，Redoc）

為了使API易於理解，實施和維護，重要的文檔。我們使用Swagger UI和Redoc（最受歡迎的API渲染工具）配置基於OpenAPI規範的自動文檔生成。

這樣可以讓您提供一個開發的chicamintactive接口，您可以在其中研究方法結構，測試查詢並快速連接到您的API。

文檔中包含的內容

第 節 說明

-------------------------------	--------------------------------------------------------------
端點和方法	路由完整列表、HTTP方法、參數、標題
curl、Postman、JavaScript、Python和其他語言的腳本	查詢/響應示例
授權	支持JWT, OAuth2, API Key直接來自界面
物件架構	描述模型、嵌套結構及資料需求
錯誤代碼	所有可能的狀態都有解釋

我們使用的工具

Swagger UI-具有測試功能的交互式瀏覽器文檔
Redoc是一個可讀、靜態的界面,非常適合在網站上發布
OpenAPI 3.0/3.1-規範格式,以構建所有內容
自動生成代碼-自動註釋、說明、版本和文檔更新
導出到JSON/YAML/HTML

為團隊和合作夥伴帶來的好處

加快新開發人員的步伐
減少集成中的錯誤
始終是最新、與代碼同步的文檔
無需技術支持即可快速啟動集成
在公共或私人門戶網站上輕松發布文檔

在哪裏，特別重要

面向外部開發人員的開放API
具有主動開發的內部API
具有B2B集成和SDK的平臺
需要法規和計劃驗證的服務

Swagger和Redoc是新一代API文檔的標準。我們將配置文檔的生成、更新和發布，以便任何開發人員都可以在幾分鐘內開始與您的API集成。