产品信息
什么是 Redocly?
ReDoc - OpenAPI/Swagger 生成的 API 参考文档
特征:
部署极其简单
redoc-cli 能够将您的文档捆绑到零依赖 HTML 文件中
服务器端渲染就绪
最广泛的 OpenAPI v2.0 功能支持(是的,它甚至支持鉴别器)
OpenAPI 3.0 支持
嵌套对象的简洁交互式文档
代码示例支持(通过供应商扩展)
响应式三面板设计,菜单/滚动同步
将 API 简介集成到侧面菜单中 - ReDoc 利用 OpenAPI 描述字段中的降价标题。它将它们拉入侧面菜单,并且还支持深度链接。
通过 x-tagGroups 供应商扩展在侧面菜单中进行高级分组
与 create-react-app 的简单集成(示例)
通过主题选项进行品牌/定制
如何使用 Redocly?
Redocly提供Redoc产品,这是一个基于OpenAPI/Swagger规范生成API参考文档的工具,旨在提供时尚、精确且交互性强的API文档,以提升开发者体验和API的成功。
Redocly 的核心功能
开放API
Redocly 的使用场景
- 生成OpenAPI/Swagger规范的API参考文档。
- 作为外部开发者展示的API文档(与Revel集成)。
- 作为内部服务目录的API文档(与Reef集成)。
- 通过模拟服务器和“试用”控制台进行API测试和交互。
- 展示复杂的API数据结构和模式。
- 收集用户对代码片段的反馈以改进文档。
Redocly 的常见问题
Redocly做什么的?
我如何使用Redocly?
Redocly有哪些核心功能?
Redocly有哪些应用场景?





















