在 swaggerUI 中选择性地禁用“试用”答案

【问题标题】：Selectively disable "Try it out" in swaggerUI在 swaggerUI 中选择性地禁用“试用”
【发布时间】：2017-12-18 01:01:12
【问题描述】：

虽然这里关于这个话题的讨论很长：https://github.com/swagger-api/swagger-ui/issues/156

我还没有找到一种更简洁的方法来“选择性地”禁用“试用”按钮。我想为我的 API 的所有 POST 方法禁用它。

提前谢谢你

【问题讨论】：

Swagger UI 的哪个版本 - 2.x 或 3.x？
如果您使用的是 OAS 3.x，请查看以下主题github.com/swagger-api/swagger-ui/issues/3725

标签： reactjs redux swagger swagger-ui

【解决方案1】：

Swagger UI 3.10.0+ 和 2.x 提供 supportedSubmitMethods 选项来控制哪些 HTTP 方法启用了“试用”（默认 = 全部）。

禁用 POST 的“试用”（但不是 PATCH/PUT）：

// index.html (Swagger UI 3.10+)

const ui = SwaggerUIBundle({
  url: "http://my.api.com/openapi.yaml",
  supportedSubmitMethods: ["get", "delete", "options", "head", "patch", "trace"], // No "post"
  ...
})

要对除 GET 和 HEAD 之外的所有方法禁用“试用”：

  supportedSubmitMethods: ["get", "head"],

【讨论】：

【解决方案2】：

如果您使用的是 OpenAPI，您可以通过环境设置来控制它，如果您有多个安装，这很好

例如，这仅启用 get 和 put 动词。 SPRINGDOC_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS=get,put

动词列表见https://springdoc.github.io/springdoc-openapi-demos/springdoc-properties.html（只是通常的http动词）

【讨论】：