问题标签 [redoc]

有人可以分享一些关于如何使用 ReDoc 和 SpringBoot 框架来实现 API 文档的示例。如果有人知道 ReDoc + Springboot 的一些很好的例子，那将是很大的帮助。

在 Redocly 中，如何在 x-codeSamples 标记中引用外部文件？Redocly 参考指南：https ://redoc.ly/docs/api-reference-docs/vendor-extensions/redoc-supported-extensions/#x-codesamples

在以下示例中，第一种情况（“示例请求”）正确呈现。第二种情况（'Schema'），仅呈现为“[object object]”。这个标签是否支持 $ref 语句？

我们有很多微服务公开他们的 API，我们有一个 API 优先的方法。每个服务都有自己的 OpenApi3.0 规范文件，主要是 yaml 或 json 格式，位于它们自己的 git repo 中。

然而，就像其他公司一样，我的团队和其他内部团队在发现 API 和围绕它的文档方面遇到了麻烦。我想建立一个可以呈现所有 API 规范并使事物易于发现的中心位置。可能与说 Stripe 或 twitter 文档标准相当。

到目前为止，我找到了几种方法来实现它：

1. 使用 React 框架分别为每个规范渲染 Redoc 组件。使其可扩展，但跨服务搜索可能很困难。

2. 使用一些预先存在的工具合并所有 api 规范并将其转换为 MarkDown 以在 Slate 中显示或使用 Docusauras 和 React Redoc 东西。使用https://www.npmjs.com/package/openapi-merge-cli和 widdershins 与 slate 合并。在拥有多个 api 的公司中，我认为使用这种方法进行扩展将是一个有趣的挑战。

我不想依赖 SwaggerHub，因为它将我与特定的东西联系在一起。同样，我正在寻找具有允许商业用途的许可证的开源东西。

很想得到一些建议/经验，或者是否存在类似的东西，我可以避免重新发明轮子。

我使用 redoc + drf_yasg 来生成我用 django-rest-framwork 制作的 api 的文档。只要我添加了一个入口点，它就会很好地出现在文档中。

但是，我不明白如何在文档中添加可以在查询期间给出的搜索参数。

例如，在列表函数中，我可以传递 2 个可选参数，一个 id 和一个名称：

我没有看到文档中提到任何参数。我怎样才能添加它们？

我不知道这是否有帮助，但这是我实现重做的方式：

我有一个在 Swagger Editor 工具中构建的 OpenAPI yaml 文件。我现在想建立一个看起来完全一样的静态网站。

我想将其合并到 Gitlab CI/CD 管道中，以便自动更新任何更改。

目前，我正在使用它redoc-cli，但我真的不喜欢它的外观。此外，没有“试用”功能。

我整天都在寻找构建该静态站点的必要组件，但似乎没有任何具体的答案。

我目前正在构建我的 GitLab Pages 网站，如下所示：

我正在使用 npm 包 redoc 并尝试自定义侧边栏。我还想在侧边栏中添加更多选项。我怎样才能做到这一点？

我就是这样用的。

我为 RESTful 服务创建了一个 OpenAPI JSON 文档，并使用 ReDoc 来显示它。

有没有办法在不使用 JSON 文件或 URL 的情况下将 OpenAPI 规范作为 JSON 对象直接传递给 ReDoc？

我所有的 api 都在 fid 下，因为我的 URL 是 fid/{fid_id}/investors 或 fid/{fid_id}/users

我如何分成不同的群体说投资者和用户

现在它只显示fid

是否可以为管道工 API 创建美观且内容丰富的文档。使用#*装饰器。

我不知道如何显示默认响应，在标题后添加一小部分，甚至无法渲染我在描述中的一些乳胶方程。

好看如：

Redoc 是一个很棒的工具，但我很难理解它是如何工作的。目前，我的任务是从 api-docs.io 复制一些文档，以便使用redoc进行自助服务。

但是，我的问题是模式没有像在 api-docs 网站上那样出现在侧栏中。我不确定如何让模型也显示在侧面......而且我对 api 文档还很陌生。您还可以在此处查看模型的显示方式。请参阅下面的另一个示例。

我查看了这是否是 redoc 的一个特性，并遇到了这个合并的 PR，它（基于 PR 问题中的讨论）指出我们应该添加一个 html 元素，SchemaDefinition. 我正在使用基本的 html 文件（建议在 redoc repo 的自述文件中），但我们想使用 json 模式（用 引用spec-url）来呈现 redoc 上的文档，所以我很难理解如何操作仅使用 html 元素的侧栏。

也许这只是我对redoc如何工作的理解不足。如果您觉得是这种情况，那么快速的解释会很棒。