了解ReDoc

最新推荐文章于 2024-04-23 10:42:28 发布
最新推荐文章于 2024-04-23 10:42:28 发布
阅读量7.1k 收藏 3
点赞数 1

REDOC - OPENAPI-POWERED DOCUMENTATION UI

伊万·贡查罗夫

 

伊万·贡查罗夫

   

REDOC - OPENAPI-POWERED DOCUMENTATION UI

我们都喜欢SwaggerUI。这是Swagger / OpenAPI如此受欢迎的原因之一。最近API文档世界出现了一些新的趋势。其中之一是三面板设计文档。竞争的API规范格式有它们，例如API Blueprint有aglio，Postman有Postman Documenter等。

这就是为什么  APIs.guru一直在开发新的重新发明的OpenAPI驱动的文档--ReDoc。我们为我们的客户Rebilly做。但它是完全开源和免费的！

看看我们的演示吧！

 

三面板设计

 

ReDoc采用响应式三面板设计：

 

左侧面板包含滚动同步参考菜单。中间面板包含端点/方法文档。右侧面板包含各种样本：请求样本，响应样本和代码样本（通过供应商扩展）。

 

有效负载文档

 

ReDoc的主要功能是记录复杂的请求/响应有效负载：

ReDoc有效负载文档

如您所见，ReDoc支持嵌套模式，并可以就地折叠/展开它们。

此外，你不会相信，但ReDoc支持 discriminator:

ReDoc鉴别器

 

回复文件

 

所有方法响应都列在方法定义下，并根据响应代码进行着色。响应还包含标头和有效负载文档：

ReDoc回应

 

样品

 

有效负载样本基于JSON模式生成。我们开发了OpenAPI-sampler工具，可生成有意义的样本。除了type和format，它利用的default，enum并example从规范场。

由于样本可能很大，因此默认情况下仅扩展第一级。您甚至可以使用“复制”按钮将完整样本复制到剪贴板：

Redoc副本

如前所述，ReDoc通过OpenAPI供应商扩展支持自定义代码示例。查看我们的  文档或  示例模式以获取更多详细信息。

 

其他特性

 

 

简单集成

 

不需要后端。所有ReDoc资源（HTML，CSS，JS）都捆绑在一个文件中，可以从我们的CDN访问。看看最小的index.html：

 

<span style="color:#212529"><span style="color:#212529"><code><!DOCTYPE html></code></span></span>

 

<html>

<head>

<title>API Docs</title>

<!-- needed for mobile devices -->

<meta name="viewport" content="width=device-width, initial-scale=1">

</head>

<body>

<redoc spec-url="http://petstore.swagger.staging.wpengine.com/v2/swagger.json"></redoc>

<script src="https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js"></script>

</body>

</html>

 

 

 

介绍部分

 

ReDoc从Swagger描述中拉出1级降价标题并将其拉入参考菜单！因此，您可以轻松地向API文档添加自定义部分。

 

你的品牌标志

 

ReDoc使用x-logo 供应商扩展程序在文档中显示您的品牌徽标。

 

下一步是什么？

 

我们已经开始研发新版本了。将包括哪些新功能？这取决于您的反馈！不要犹豫，在我们的GitHub上打开问题和功能请求。我们欢迎您的建议！

此外，您可以聘请APIs.guru来协助ReDoc集成或为ReDoc驱动的文档开发独特的外观。

myprogram513
关注
  • 1
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
redoc
03-08
redoc
redoc-demo:ReDoc API文档平台演示
03-18
还原演示 ReDoc API文档平台演示
使用redoc来生成文档
funnyPython的博客
07-02 6303
redoc只需要一个.yaml就可以生成一个很漂亮的文档。 https://github.com/Redocly/redoc 这是一个写接口文档的神器，里面的格式可以参照openapi3.0来写。 根据https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md 知道它的结构了可以点目录速查 比如你现在写了一个openapi.yaml的文档 安装 redoc-cli npm i -g redoc-cli 执行如下
spring boot + swagger3 + redoc使用
最新发布
鱼儿锅头的博客
04-23 868
**} });} }/**} });} }/**} });} }/**} });} }Lists;} }/**} });/**} });} }
redoc：redoc-从多个项目存储库生成文档
02-04
重做 redoc是一个应用程序，可用于显示来自多个Github存储库的样式化Markdown 。 redoc从GitHub获取内容并 ，缓存HTML以通过目录进行管理，并以主题包进行样式化。 git clone https://github.com/reactioncommerce/redoc.git cd redoc && npm install meteor --settings settings.json 要运行测试： npm run test -运行单元测试npm run test-app “完整应用”测试npm run chimp运行浏览器测试（在应用运行时） npm run
redoc：:blue_book:OpenAPISwagger生成的API参考文档
02-04
OpenAPI / Swagger生成的API参考文档 这是ReDoc（基于React）的2.0版本的README。 1.x版本的自述文件位于分支 产品特点 极其容易的部署 能够将您的文档捆绑到零依赖的HTML文件中 服务器端渲染准备就绪 支持最广泛的OpenAPI v2.0功能（是的，它甚至支持discriminator符） OpenAPI 3.0支持 嵌套对象的整洁交互式文档 代码示例支持（通过供应商扩展） 响应式三面板设计，具有菜单/滚动同步 将API简介集成到侧面菜单中-ReDoc利用了OpenAPI描述字段中的markdown标题。 它将它们拉到侧面菜单中，还支持深度链接。
swagger生成redoc文档
一个天蝎座的程序猿
02-26 4036
一、安装工具 npm install -g redoc-cli 二、生成文档 redoc-cli bundle -o index.html swagger.json { "openapi": "3.0.2", "info": { "title": "Workflow", "description": "API to access AnyShare\r\n\r\n如有任何疑问，可到开发者社区提问：https://developers.aishu.cn\r\n# Authentic
redoc-test：重做测试
03-03
10. **反馈循环**：测试结果应反馈给开发团队，以便他们了解问题的性质和严重性，以及如何防止类似问题再次发生。 总的来说，"redoc-test：重做测试"意味着在一个涉及Redoc的项目中，测试流程正经历一个迭代周期，...
C语言开发工具 TC 2.0 （可以汉化）
08-22
TC 2.0，全称为Turbo C 2.0，是Borland公司于1980年代末推出的C语言编译器，是许多初学者入门编程的首选...尽管现在有更多先进和功能强大的工具，但了解和使用TC 2.0对于理解编程历史和技术演进仍然具有一定的意义。
redocly的离线安装包，可以从openapi生成html网页
09-23
首先，我们要了解Redocly的工作原理。它通过解析OpenAPI规格文件（通常为`.yaml`或`.json`格式），将这些规范转换为一个交互式的、可浏览的HTML文档。这使得API消费者可以直观地看到端点、参数、请求和响应等信息，...
fastAPIStaticSite：适用于SENG 5199的Cloud Frankensteins
02-26
这些端点为用户提供了一个清晰的接口，以便了解和交互网站的功能。 根路径"/"通常用于显示网站的主页，向用户介绍网站的基本信息或提供导航。"/doc"端点是FastAPI的内置文档页面，它展示了API的接口定义，包括每个...
Redocly-POC:测试Redocly Developer门户
03-25
Checkout.com API开发人员门户 先决条件 安装 要运行此项目或故事书，您首先必须安装节点模块。 yarn install 启动开发服务器 运行该项目并在浏览器中查看它。 运行以下命令：注意：搜索在开发环境中不起作用。 yarn start 故障排除 我们严重依赖于缓存来解决性能问题，因此，如果在生成的门户中未反映出某些更改，请尝试运行以下命令来清理缓存： yarn clean 文件 阅读。 故事书 隔离地构建组件或查看现有组件。 运行以下命令并打开localhost：6006 yarn storybook
redoc-tryout:ReDoc的试用功能
05-10
还原尝试 这是为Redoc提供试用功能的权宜之计解决方案： : 此实现使用JQuery，它位于ReDoc旁边，等待其完全加载，然后将按钮与单击侦听器绑定。 进行了单独的Ajax调用，以仅为Try-out功能加载swagger.json。 单击“ Try-Out按钮时，将在swagger.json之后生成一个表单。 演示： ： 怎么跑 克隆项目。 在浏览器中打开demo.html。 “ Try-Out按钮应显示在右侧面板上每个方法的下方。 单击“ Try-Out以Try-Out表格。 单击Send以发出http请求。 请注意，由于这是Bowser Ajax调用，因此将redoc部署在单独的主机中时，您的api应该以正确的CORS标头响应。 如何配置 全局变量var defaultHost ：默认情况下，http将进入swagger.json中的.host属性。 如果swagger
免费的API文档编写工具
qf2019的博客
09-27 2249
1.具有无可挑剔的品牌选项的免费API文档工具：ReDoc.ly 我们列表的顶部是 ReDoc。作为帮助团队使用 OpenAPI 构建 API 规范的咨询服务，ReDoc 工具功能强大，同时支持 OpenAPI v2 和 OpenAPI v3。 那么为什么它是我们的最爱呢?主要是灵活性。事实上，ReDoc 以四种不同的模式工作： ReDoc 代码的托管构建： 您只需使用他们提供的 HTML 模板构建一个网页。这将加载实现该工具的 JavaScript，您的任务是为您的 API 规范指定 URL。 Reac
探索智能API文档生成利器: ReDoc
gitblog_00010的博客
03-19 484
探索智能API文档生成利器: ReDoc 项目地址:https://gitcode.com/Rebilly/ReDoc ReDoc 是一个开源的、基于OpenAPI规范（前身为Swagger）的现代且美观的API文档生成工具。该项目由Rebilly公司维护，并以MIT许可证开放源代码，旨在让开发者可以轻松地为他们的API创建清晰、易读的文档。 项目简介 ReDoc的主要目标是提供一种简洁的方式来展...
API管理平台：你用的到底是哪个？
Hanko的专栏
04-10 1478
如果你们开发团队主要是Java与前端，基本上swagger+knife4j就足够了。因为API管理平台主要管理 的就是Java接口，实时同步更新接口文档，可以调试。如果你们开发团队是跨语言的，那么最好就选择能管理各种形式的API，不单单是swagger类型的，所以可以选择去哪儿的YApi免费开源。当然大家可以在网上看到最近Apifox比较多的广告，或许是运营做的比较好。不过最大的问题还是它没开源，私有化部署需要付费。
http://localhost:8000/redoc
09-08
引用和提到了关于API使用说明文件的内容，其中包括了ReDoc、Swagger UI和FastAPI。根据这些信息，http://localhost:8000/redoc是一个URL链接，指向一个基于FastAPI构建的应用程序的ReDoc页面。ReDoc是一个用于展示和交互式浏览API文档的工具，可以提供清晰的界面和易于使用的功能。在这个特定的URL上，用户可以查看API的详细文档、请求示例、参数说明等内容，帮助用户更好地理解和使用该API。<span class="em">1</span><span class="em">2</span><span class="em">3</span>

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值