我们都喜欢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