不同模式查看API文檔

APIGit

2022-11-15

APIGit 為查看 API 文檔提供了靈活且用戶友好的體驗。您可以輕鬆地在不同的查看器之間切換以從不同的角度查看同一文檔,從而讓您更深入地了解 API 及其功能。默認查看器是使用流行的開源 Redoc 查看器構建的,它提供了一個有吸引力且直觀的佈局,可以輕鬆瀏覽和理解 API 文檔。

API main

Swagger 查看器是用於可視化 API 文檔的經典且易於使用的選項。它提供了一個簡單、整潔的佈局,允許清晰高效的導航。此外,此查看器針對性能進行了優化,使其成為大型或複雜 API 文檔的理想選擇。它提供了一種理解和導航 API 文檔的傳統方式,這種方式簡單易懂。

swagger UI

代碼查看器提供 API 文檔的原始且未格式化的視圖,讓用戶可以詳細了解文檔的底層結構和格式。此查看器對於調試錯誤特別有用,因為它允許用戶查看 API 中使用的確切代碼和格式。此外,對於 API 開發專家而言,代碼查看器可以成為編輯 API 文檔的有效方式,提供對底層代碼的輕鬆訪問。對於希望以更技術性的方式理解 API 文檔並對其進行更改的開發人員和專家來說,此查看器是最佳選擇。

Code viewer

Diff 查看器允許用戶比較存儲庫中的兩個不同的 API 文檔。此功能對於第三方集成特別有用,因為它允許輕鬆查看和理解對自動生成的 API 文檔所做的任何更改。它有助於比較 API 文檔中所做的更改並以更好的方式理解更新。它是審查更新、合併更改和確保 API 文檔一致性的好工具。

diff viewer