有选择地禁用"尝试一下"在swaggerUI中

时间:2017-12-18 01:01:12

标签: reactjs redux swagger swagger-ui

虽然这里有关于这个主题的长时间讨论:MongoDB as a Time Series Database

我没有找到一种更清洁的方式来选择性地'禁用"尝试一下"按钮。 我想为我的API的所有POST方法禁用它。

提前谢谢

2 个答案:

答案 0 :(得分:0)

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"],

答案 1 :(得分:0)

如果您使用的是OpenAPI,则可以通过环境设置来控制它,如果您有多个安装,那就很好了

例如,这仅启用获取和放置动词。 SPRINGDOC_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS =获取,放入

请参阅https://springdoc.github.io/springdoc-openapi-demos/springdoc-properties.html以获得动词列表(只是常用的http动词)