產品

API設計

APIGit 使用廣泛接受和支持的 OpenAPI 規範 3.0.x 作為定義行業 REST API 的標準。我們自主開發的、易於使用的、完全可視化的 OpenAPI 編輯器允許您快速、輕鬆地編寫 API 規範,而無需任何 OpenAPI 規範的先驗知識。可視化界面使任何人都可以輕鬆理解和創建 API 文檔,簡化開發過程並使您能夠專注於創建符合行業標準的高質量 API。

API 規範查看模式 - 默認
在查看模式下,您可以通過視覺上令人愉悅的設計主題來查看 API 文檔。此外,您還可以根據自己的喜好選擇切換到原始的 swagger 主題。 API 規範在發佈時將完全相同。通過點擊“編輯”按鈕,您可以進入 API 編輯模式。
API Spec 查看方式——swagger-ui view
在swagger視圖模式下,您可以在swagger主題中查看API規範,讓您輕鬆理解和交互標準格式的API文檔。
API Spec 查看方式——代碼查看
在代碼模式下,顯示原始、純 API 規範內容,提供底層代碼的直接視圖。
API 規範查看模式 - 差異視圖
在差異視圖模式下,您可以將一個 API 規範與另一個 API 規范進行比較,並輕鬆識別它們之間的差異。

API規範編輯模式-表單視圖
通過單擊“編輯”按鈕,API 規范進入表單編輯模式,使其成為修改 API 的最簡單方法。這種模式不需要任何 OpenAPI 知識,因為規範完全可視化,易於理解和編輯。
API規範編輯模式-代碼視圖
在代碼模式下,您可以查看原始 API 文檔內容,方便您直接編輯或排查規範中的任何問題。
API規範編輯模式-差異視圖
在diff 模式下,您可以將正在編輯的API 規範的當前版本與其原始版本進行比較,並直接對內容進行編輯。這使您可以輕鬆識別和解決兩個版本之間的任何差異,確保更改準確並與原始版本保持一致。

創建或上傳 API 規範
我們的平台提供了創建空 API 規範或將現有 API 規範上傳到存儲庫的能力。此外,我們支持上傳 HAR 文件的選項,該文件會自動將其轉換為 API 規範。