不要在 Swagger UI 中预先填充示例尝试功能

Lin*_*nda 6 swagger swagger-ui openapi

是否可以在 Swagger UI 中禁用 OAS 3.0 规范中的预填充示例?

我有一个 GET 请求,允许通过许多不同的参数进行过滤。当用户单击“尝试”时,所有参数都会预先填充。由于选择的过滤选项数量巨大,因此永远不会有任何结果。

如果用户想要提出任何有意义的请求,他们必须首先进入并删除每个示例。

这似乎是 Swagger 2.0 的默认设置,但 OAS 3.0 似乎没有这个选项。

我尝试更改各种设置但没有成功。

唯一有效的是将定义从 OAS 3.0 更改为 Swagger 2.0。但这显然不是一个可行的解决方案。

当规范定义为 OAS 3.0 时:

{
  "openapi": "3.0.0",
  "paths": {...}
}
Run Code Online (Sandbox Code Playgroud)

Swagger UI 默认会自动填充 Try it Out 中的所有示例

当规范定义为 Swagger 2.0 时:

{
  "swagger": "2.0",
  "paths": {...}
}
Run Code Online (Sandbox Code Playgroud)

Swagger UI 默认将所有示例留空

笔记:

  • 上面示例中的其余规范和所有设置保持不变。