Redocly
围绕 OpenAPI、GraphQL 和 AsyncAPI 描述文件生成 API 参考页与开发者门户的平台,支持页面内试接口、Mock 服务器和 MCP 查询,适合研发团队在每次 pull request 时核对文档与真实接口是否一致。
3 次可以打开平均 0.6 秒
本站从国内机房定期实测。竖条由远及近:绿 = 可以打开,橙 = 国内不可直接访问,灰 = 打不开。Redocly 是一个围绕 API 描述文件做文档的平台。你把仓库里的 openapi.yaml 交给它,它生成可交互的 API 参考页、开发者门户和 API 目录;描述改了,参考文档和 Mock 服务器跟着变。文档正文用 Markdown、Markdoc 或 React 写在同一个 Git 仓库里,每次 pull request 都会生成预览。
主要功能
参考文档支持 OpenAPI、GraphQL 和 AsyncAPI,读者能在页面上直接发请求试接口(Replay 控制台),切换环境和变量。Mock 服务器从描述生成,后端还没上线就能返回示例响应。SDK 生成覆盖 TypeScript、Python、Go、PHP,标注为早期访问。Arazzo 工作流把多步调用序列跑在 Mock 和生产环境上,用来验证文档和真实 API 是否一致。
面向 AI 的部分是近来的重点:每个 pull request 会给 API 描述打一个 agent-readiness 分数,指出示例缺失、错误响应没写、鉴权没说明之类的问题;发布后的文档可以作为 MCP 服务器供 AI 代理查询,站内还有带引用的 AI 助手回答读者提问。团队侧有 Reviewer 代理审文档 PR 并起草修改,均处于 beta。
费用与限制
所有套餐都不按人头收费,席位、读者和 Git 贡献者不限。Pro 每月 249 美元(按年付 2988 美元),含 3 个项目,多加一个项目每年 390 美元;Scale 每月 729 美元(按年付 8748 美元),含 10 个项目。项目指一个带独立仓库和域名的文档站。AI 助手和 Reviewer 代理在所有套餐内提供,有使用量限制;受保护文档、可嵌入组件、API 目录等能力要 Scale 或 Enterprise。注册后可免费试用 30 天,不需要信用卡。
适合谁
有专门 API 文档站、希望文档跟代码一起走 review 流程的研发团队。文档托管在 GitHub、GitLab、Bitbucket 或 Azure DevOps 都能接。只想把一份 OpenAPI 描述渲染成参考页的话,同门的开源项目 Redoc CE 更轻。
