这是干什么的?
Redoc 是一个开源工具,可以根据 OpenAPI(原名 Swagger)定义生成 API 参考文档 — 它把你的 spec 文件变成一个排版精美、易读的参考页面。
Redoc 是一个开源工具,可以根据 OpenAPI(原名 Swagger)定义生成 API 参考文档 — 它把你的 spec 文件变成一个排版精美、易读的参考页面。生成的文档长什么样?一个自适应的三栏网页:左边是搜索栏和导航菜单,中间是文档正文,右边是请求和响应示例。
一个自适应的三栏网页:左边是搜索栏和导航菜单,中间是文档正文,右边是请求和响应示例。怎么从我的 spec 文件生成文档?装好 Node 之后,用 npx 对你的 OpenAPI 定义运行 Redocly CLI — 它会生成一个 redoc-static.html 文件,直接用浏览器打开就行。
装好 Node 之后,用 npx 对你的 OpenAPI 定义运行 Redocly CLI — 它会生成一个 redoc-static.html 文件,直接用浏览器打开就行。必须装 Node 吗?用 CLI 这条路需要 Node。如果不想配置 Node,还有 Docker 镜像、可以嵌进任意网页的 HTML 标签,以及用于应用集成的 React 组件。
用 CLI 这条路需要 Node。如果不想配置 Node,还有 Docker 镜像、可以嵌进任意网页的 HTML 标签,以及用于应用集成的 React 组件。和 Redocly 的托管产品相比,用这个少了什么?Redoc 是社区版。付费的托管版本额外提供试用控制台、自动生成的代码示例、完全自定义的样式、mock 服务器,以及对 AsyncAPI 和 GraphQL 的支持。
Redoc 是社区版。付费的托管版本额外提供试用控制台、自动生成的代码示例、完全自定义的样式、mock 服务器,以及对 AsyncAPI 和 GraphQL 的支持。它支持哪些 API 描述格式?OpenAPI 3.1、OpenAPI 3.0 和旧版 Swagger 2.0 定义都支持,所以老的 Swagger spec 不用转换就能直接用。
OpenAPI 3.1、OpenAPI 3.0 和旧版 Swagger 2.0 定义都支持,所以老的 Swagger spec 不用转换就能直接用。能不能不装任何东西就预览文档?可以 — 有一个在线演示,默认会渲染一个示例 Petstore API;输入你自己 OpenAPI 定义的 URL,然后点击 TRY IT,就能看到 Redoc 的渲染效果。
可以 — 有一个在线演示,默认会渲染一个示例 Petstore API;输入你自己 OpenAPI 定义的 URL,然后点击 TRY IT,就能看到 Redoc 的渲染效果。这个 CLI 只能用来生成 HTML 文件吗?不是 — Redocly CLI 还能对你的 OpenAPI 文件做 lint 检查和打包,所以文档生成可以融入更完整的 API 工作流程。
不是 — Redocly CLI 还能对你的 OpenAPI 文件做 lint 检查和打包,所以文档生成可以融入更完整的 API 工作流程。实际上有哪些人在用 Redoc?展示页里列出了不少 Redocly 工具的用户,比如 Docker Engine、Zuora、Discourse、Rebilly、APIs.guru 和 Quaderno API。
展示页里列出了不少 Redocly 工具的用户,比如 Docker Engine、Zuora、Discourse、Rebilly、APIs.guru 和 Quaderno API。What are similar projects?swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalar
swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalarWhich topics is it in?openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm
openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm