问题标签 [redoc]

使用路径参数petId作为id请求正文中的字段值。我们该怎么做？

我正在使用Swashbuckle.AspNetCore并添加x-codeSamples以下代码：

我可以在 JSON 文件中看到这一点：

但代码示例未显示在 UI 中。请帮我看看怎么回事？

我正在使用 OpenAPI v3 和 springdoc 并希望从 ReDoc 中隐藏枚举常量：

请注意，我不想隐藏属性status。我希望它的常量不会出现在 API 文档中。我怎么能做这样的事情？

我在主要部分中显示了错误代码描述：

但我还想在此处的示例部分中显示这些代码描述：

我在示例部分看到了一些可以生成这些描述的 API 文档：

我怎么能做这样的事情？

PS：请注意，我正在使用 springdoc 公开开放 API 规范。

我克隆了 Swashbuckle.AspNetCore 并尝试构建它但是缺少 node_modules 文件夹

我运行npm i redoc并得到以下输出

我应该如何进行？

这是我在 startup.cs 中的配置

API 版本显示为招摇。下面是图片

但同样的事情并没有发生在 REDOC 上。下面是图片

如果我将 url 从 https://localhost:44311/redoc/index.html?url=/swagger/v1/swagger.json 更改为 https://localhost:44311/redoc/index.html?url=/swagger/ v2/swagger.json 只需将 v1 更改为 v2 即可获得 v2 的 API。但我希望 REDOC UI 应该有一个用于版本选择的下拉菜单。任何人都可以帮助我吗？

我的码头文件 -

构建并运行命令-

使用上面的命令，我可以轻松地将 yaml 文件转换为 html 文件。但是我想以这样的方式编写一个 dockerfile，如果我更改 yaml 文件中的任何内容，那么它将再次转换为 html。这个过程将是连续的。

请给我建议。我是码头工人的新手。

我最近深入研究了 OpenAPI 规范并一直在使用redoc-cli，但是，我遇到了一个小问题。

我有以下内容：

但是，结果输出是对象的形式。

希望这里有一些大师能够帮助我看看这有什么问题。干杯。

在服务器对象中，我定义了一个 URL：

在响应定义中我想引用这个服务器 URL：

是否可以从 Location 响应标头的示例中引用服务器 URL？

以前在 Django 1.11 中，我以这种方式定义了 Django REST API：

在 url.py 中

在 api.py

现在我正在迁移到 Django 3.1.5，我想知道如何以与 Django Rest Framework (DRF) 相同的方式实现上述目标。在上述特殊情况下，POST API“test_token”接受一个参数。并生成 API 文档，如 swagger/redoc（可用于测试 API）

一些注意事项：

• 它还在这里指出，django-rest-swagger 已于 2019 年 6 月弃用django-rest-swagger UI 没有 POST 请求正文的形式（基于函数的视图）
• 需要注意的是，它使用 request.POST （表单数据）作为参数https://www.django-rest-framework.org/tutorial/2-requests-and-responses/
• 在 Django 1.11.x 中，我使用了这个 swagger_schema.py - https://gist.github.com/axilaris/b7152215a76f6f1f5ffca0436991328d

如何在 Django 3.x 上实现这一点？（如标题：Django Rest Framework custom POST URL endpoints with defined parameter with Swagger or other doc）

更新：

我认为这里有某种形式的解决方案： https ://github.com/tfranzel/drf-spectacular/issues/279

由于我有很多使用 @api_view 的 API，因此对装饰器 @extend_schema 的更改文档字符串可能是最简单的迁移路径。我希望有人可以提供有关 url.py 使用 @extend_schema 进行转换的指导。这是为了实现 url 端点和招摇。谢谢。

然而，这是我与 drf-spectacular 最接近的

它给出这个（这是不正确的），注意令牌查询

而不是 POST 输入参数（如何得到这个？）

解决方案：

网址.py