问题标签 [redoc]

OpenAPI 对 RESTful 服务很有用，目前，我正在破解它，通过使用POSTto a来为异步消息传递系统（特别是 Kafka）做这件事，/topic这样我就可以使用 redoc 为 API 创建一个网站。

我正在尝试查看是否已经建立了为此记录的系统。尤其是因为GET /events用于事件溯源的数据越来越大。

我在 Swagger 中创建了一个文档，我正在尝试使用 redoc（来自 npm）将 json 转换为 html。

当我输入这个命令时：

我收到此错误：

我该如何解决这个问题？提前致谢

我正在用 Swagger 构建一个 API 文档，我直接在 JSON 中的 Notepad++ 中编写它一切都很好，但现在我有一个 POST 请求，它有一个 xml 类型的响应示例。这是我写的代码

您能否就问题所在给我建议，因为当我使用 redoc 将其转换为 html 时，它不会在页面右侧显示任何响应示例。

提前致谢

我正在使用 django、django drf 和 drf-yasg 来生成编写我的 BE 并生成文档。

我有一个名为 User 的模型和一个用于用户的序列化程序：

我有一些方法 Foo 可以获得两个用户。这是请求的序列化程序的样子：

当我为此生成一个swagger json方案时，我查看了json和redoc，我看到了：

1. first_user 和 second_user 具有相同的引用名称 ($ref)
2. second_user 和 redoc 的描述为“第一个用户”而不是第二个用户。这是因为描述取自具有第一个用户描述的 $ref。

我注意到，如果我确保引用名称是不同的，那么 redoc 就可以很好地读取，因为 first_user 和 second_user 得到了他们自己的描述。问题来了，因为我还希望以后能够使用 swagger codegen 创建 Java 存根，所以解决方案和据我所知，每个不同的 ref 名称都有一个不同的类。理想情况下，我会看到对 foo 的调用类似于

这让我想到了一个问题：

• 如果 first_user 和 second_user 具有相同的 ref 名称，则 redoc 读取错误并且第二个用户具有第一个用户描述。

• 如果 first_user 和 second_user 具有不同的引用名称，那么 redoc 可以工作，但我会生成两个不同的类，比如

  Foo(FirstUser first_user, SecondUser second_user)

我需要做什么才能使重做和生成的类都按预期工作？

我为 OpenApi Restful 服务创建了一个 JSON 文档。我想知道是否有办法在不使用外包网站的情况下加载 json 文件。对不起，如果这是一个愚蠢的问题，我是 OpenApi 的新手。

这是html代码；

我想加载没有 spec-url 的 json 文件。<redoc spec-url="https://api.myjson.com/bins/json" ></redoc>

我正在使用drf-yasg文档，我正在使用redoc并且效果很好。但我想添加x-serverand x-taggroups。我想为视图设置自定义标签，并将它们添加到他们自己的标签组中，但是我在文档中找不到任何关于这个的东西，我应该怎么做？

目前我正在编写我的 API 文档，我决定用 ReDoc 来实现它。我的 API 使用 Spring Boot 构建。对于文档，我使用的是 SWAGGER。一切都很好，但我无法注释我的控制器以在 ReDoc 文档的右侧显示“响应样本”部分。我尝试在 DTO 中添加示例，例如：

这是我的控制器的样子：

我在请求对象上定义了一个动态字段，如下所示：

但是，在我们的文档中，这些字段显示为：

有没有办法使用 ReDoc 向该字段添加更用户友好的描述？我至少希望 ReDoc 尊重示例文本。注意 - 这是在使用 Swashbuckle 的 dotnet 核心 API 中。

我们有一个正在运行的 Redoc 服务器，其中包括一堆带有 api 规范的 yaml 文件。但是，一些必要的 yaml 文件不在本地（我们称之为RedocServer）机器上。

这些远程文件可通过 aspnet-webapi 服务 ( WebApiServer ) 访问。

因此，假设要获取其中一个文件，我们在 index.yaml 文件中使用引用：

如果 ApiDoc.yaml 本身没有引用，那么WebApiServer使用如下方法简单地返回一个字符串是没有问题的：

然而，在我们的例子中，ApiDoc.yaml有一些巨大的、嵌套的对其中另一个文件的引用。类似的东西，暗示被引用的对象内部有引用：

如果WebApiServer返回类似的字符串，RedocServer可能会尝试使用RedocServer文件解析这些引用。但我们显然希望确保在WebApiServer端解析引用。

所以，问题是，如何在不破坏任何引用的情况下正确返回该 ApiDoc.yaml？

我们无法手动解析引用，因为对象很大且嵌套很深。我们尝试使用的 OpenApi.net 仍然无法自动解析远程引用，而且似乎也无法处理没有“info”和“openapi:3.0.0”部分的文件。

我需要通过 C# 设置一些具有相同 http 状态代码的响应示例。

我研究了帖子
https://blog.rsuter.com/nswag-tutorial-implement-a-custom-operation-processor-to-define-redoc-code-samples/

但我还是不知道。

我能怎么做 ？
请给我一些提示...

更新：我使用 NSwag，像这样
我需要让代码 404 有两个示例响应