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