API 文檔面板
標題和版本:在頁面頂部,你會看到 API 的名稱和版本號。
描述:提供了 API 的簡介,幫助用戶了解其功能。
端點列表
每個 API 端點都會列出來,通常以 HTTP 方法(GET、POST 等)和路徑顯示。
用戶可以展開每個端點來查看詳細信息。
端點詳情
請求參數:顯示需要的參數及其類型(如 query、header 或 body)。
響應示例:提供成功和錯誤響應的示例,以便用戶了解 API 的行為。
測試功能
用戶可以直接在界面中測試 API。輸入必要的參數後,點擊「Tr
y it out」按鈕進行請求。
會顯示請求和響應的詳細信息,包括狀態碼和數據。
文檔生成
Swagger UI 自動生成的 API 文檔讓開發者輕鬆分享和維護 API 說明。
搜索功能
提供搜索框,可以快速查找特定的端點或參數。