我们都喜欢 SwaggerUI。这是 Swagger/OpenAPI 如此受欢迎的原因之一。最近，API 文档领域出现了一些新趋势。其中之一是三面板设计文档。竞争的 API 规范格式也有它们，例如，API Blueprint 有 aglio，Postman 有 Postman Documenter 等。
这就是 APIs.guru 一直在开发新的、经过重新设计的基于 OpenAPI 的文档 - ReDoc 的原因。我们为我们的客户 Rebilly 做这件事。但它是完全开源和免费的！
查看我们的演示！
三面板设计
ReDoc 采用响应式三面板设计
左侧面板包含滚动同步的参考菜单。中间面板包含端点/方法文档。右侧面板包含各种示例：请求示例、响应示例和代码示例（通过供应商扩展）。
有效负载文档
ReDoc 的主要功能是能够记录复杂的请求/响应有效负载
如您所见，ReDoc 支持嵌套模式，并将其就地显示，并具有折叠/展开功能。
而且，您可能不相信，但 ReDoc 支持 discriminator:
响应文档
所有方法响应都列在方法定义下，并根据响应代码着色。响应还包含标头和有效负载文档
示例
有效负载示例是根据 JSON 模式生成的。我们开发了 OpenAPI-sampler 工具，它可以生成有意义的示例。除了 type 和 format，它还利用了规范中的 default、enum 和 example 字段。
由于示例可能很大，因此默认情况下仅展开第一级。您甚至可以使用 “复制” 按钮将完整示例复制到剪贴板
正如前面提到的，ReDoc 通过 OpenAPI 供应商扩展支持自定义代码示例。查看我们的 文档 或 示例模式 以获取更多详细信息。
其他功能
简单集成
不需要后端。所有 ReDoc 资源（HTML、CSS、JS）都捆绑到一个文件中，并且可以从我们的 CDN 访问。查看最小的 index.html
<!DOCTYPE html>
<html>
<head>
<title>API 文档</title>
<!-- 移动设备需要 -->
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<redoc spec-url="http://petstore.swagger.io/v2/swagger.json"></redoc>
<script src="https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js"></script>
</body>
</html>
简介部分
ReDoc 从 Swagger 描述中提取第一级 Markdown 标题，并将其提取到参考菜单中！因此您可以轻松地将自定义部分添加到您的 API 文档中。
您的品牌徽标
ReDoc 使用 x-logo 供应商扩展在文档中显示您的品牌徽标。
下一步是什么？
我们已经开始着手新版本的开发。将包含哪些新功能？这取决于您的反馈！请随时在我们的 GitHub 上提出问题和功能请求。我们欢迎您的建议！
此外，您可以聘请 APIs.guru 协助 ReDoc 集成或为您的 ReDoc 支持的文档开发独特的外观。
别忘了在 GitHub 上为我们的项目加星！ <3