Repolode
提交项目
Redocly

Redocly/redoc

开源工具，可根据 OpenAPI、Swagger、AsyncAPI 或 GraphQL 定义生成响应式的 API 参考文档站点。

可替代:SwaggerUI

在 GitHub 查看官网
Star
25,970
Fork
2,404
未关闭 Issue
366
最近提交
11小时前

这是什么？

Redoc 可以把 API 定义文件转换为便于浏览的文档页面。它支持 OpenAPI 3.2、3.1、3.0 和 Swagger 2.0，也能处理 AsyncAPI 3.x 和 GraphQL SDL，并自动识别文档格式。默认采用三栏布局：左侧为搜索栏和导航菜单，中间为文档正文，右侧展示请求与响应示例。

使用方式灵活：可以通过 npx 调用 Redocly CLI 生成静态 HTML 文件，可以在页面中嵌入 `<redoc>` 标签并指定规范地址，也可以作为 React 组件引入。主题可通过 CSS 变量定制，并支持深色模式。它还识别 x-logo、x-tagGroups、x-codeSamples 等 OpenAPI 扩展，用于调整输出内容。

核心功能

  • 01支持渲染 OpenAPI 3.2、3.1、3.0 和 Swagger 2.0 定义
  • 02支持 AsyncAPI 3.x 与 GraphQL SDL，并自动识别格式
  • 03响应式三栏布局，导航与内容滚动同步
  • 04通过 CSS 变量实现深色模式与主题定制
  • 05可作为 HTML 标签、React 组件或 Redocly CLI 命令使用

适用场景

  • 从 OpenAPI 文件生成对外公开的 API 参考文档
  • 将 API 文档嵌入已有的 React 或静态 HTML 网站
  • 生成独立的 HTML 文件，用于离线或内部分享

快速上手

  1. 1

    使用 npx 从 OpenAPI 文件生成文档（需要 Node）

    npx @redocly/cli build-docs openapi.yaml
  2. 2

    在浏览器中打开生成的 redoc-static.html 文件

使用前须知

  • 社区版不包含 Try-it 面板、模拟服务器和 SOAP 支持等功能，这些仅在托管版 Redoc 中提供。
  • Redoc 默认收集匿名使用和性能数据，如需退出须设置 disable-telemetry 或 disableTelemetry。

标签

#api-documentation#openapi#swagger#documentation-generator#asyncapi#graphql#react#documentation-tool#hacktoberfest#openapi-specification

常见问题

redoc 是什么？
开源工具，可根据 OpenAPI、Swagger、AsyncAPI 或 GraphQL 定义生成响应式的 API 参考文档站点。 Redoc 可以把 API 定义文件转换为便于浏览的文档页面。它支持 OpenAPI 3.2、3.1、3.0 和 Swagger 2.0，也能处理 AsyncAPI 3.x 和 GraphQL SDL，并自动识别文档格式。默认采用三栏布局：左侧为搜索栏和导航菜单，中间为文档正文，右侧展示请求与响应示例。
redoc 可以免费使用吗？用的什么许可证？
redoc 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
redoc 还在维护吗？
活跃维护中。redoc 最近一次提交是在 2026年10月20日。
redoc 适合用来做什么？
从 OpenAPI 文件生成对外公开的 API 参考文档 将 API 文档嵌入已有的 React 或静态 HTML 网站 生成独立的 HTML 文件，用于离线或内部分享
redoc 怎么安装和运行？
使用 npx 从 OpenAPI 文件生成文档（需要 Node）: npx @redocly/cli build-docs openapi.yaml 在浏览器中打开生成的 redoc-static.html 文件
在哪里获取 redoc？
源代码和安装说明在 GitHub 上：https://github.com/Redocly/redoc

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目