產品

API文檔

APIGit 提供用戶友好、主題精美的 API 文檔,具有多種查看模式。您可以從 API 存儲庫歷史記錄中的任何時間點發布 API 文檔,確保您始終可以訪問最新版本的文檔。此外,您還可以將自己的域指向已發布的文檔,從而以您的品牌風格呈現它們。它使您可以輕鬆地與內部團隊和外部合作夥伴共享您的 API 文檔,同時保持一致和專業的外觀。

優雅清晰的API文檔
已發布的 API 文檔由兩個部分組成:API 規範和 markdown 文檔,兩者均來自 API 存儲庫中的文件。您可以將多個 API 文檔發佈為不同的版本,並在它們之間輕鬆切換。

API規範的查看模式-默認
API規範文檔可以通過不同的方式查看,提供對API的全面了解。支持的模式包括:默認視圖、swagger-UI 和原始代碼模式。這允許您以最適合您需要的方式查看 API 文檔並與之交互。
API Specifications的查看方式-swagger UI方式
在 Swagger UI 模式下,您可以在傳統的 swagger 主題中查看 API 文檔,提供熟悉且易於使用的界面來理解 API 並與之交互。
API規範查看模式-代碼模式
在代碼模式下,您可以查看原始 API 規範文件,提供對底層代碼的直接訪問,以便在必要時輕鬆查看和進行更改。

Markdown文件
Markdown 文檔也包含在已發布的 API 文檔中。它們提供了一個理想的位置來展示您的設計概念和 API 背後的業務邏輯。此外,我們還支持 markdown 文檔的默認和代碼模式,這使您可以以最適合您需要的方式查看和審查文檔。

自定義域
設置自定義域後,您可以使用 CNAME 記錄將您自己的域指向您發布的文檔,從而允許您以自己的品牌名稱和 URL 顯示它們。