Redoc

一款開源 API 文件檢視器，從 OpenAPI（Swagger）規格檔案生成美觀、響應式且互動的文件。

部署後可以做什麼

1. 開啟您的網域 — 查看以 Redoc 呈現的預設 Petstore API 文件
2. 載入您自己的規格 — 透過 SPEC_URL 環境變數將 Redoc 指向您的 OpenAPI/Swagger JSON 或 YAML 規格 URL
3. 探索三欄式版面 — 瀏覽左側選單、中間內容和右側程式碼範例
4. 搜尋 API — 使用內建搜尋快速找到端點和結構描述
5. 分享深層連結 — 複製直接連結到特定端點或結構描述的 URL

主要功能

• 三欄式響應式版面，包含選單、內容和程式碼範例
• 支援 OpenAPI 3.1、3.0 和 Swagger 2.0 規格
• 互動式請求/回應範例，支援多種程式語言
• 內建搜尋功能，涵蓋所有端點和結構描述
• 深層連結至特定操作、標籤和結構描述
• 自動程式碼範例生成
• 支援伺服器端渲染以利 SEO
• 可自訂主題和品牌選項
• 描述中支援 Markdown
• 行動裝置友善的響應式設計

授權條款

MIT — GitHub