SWAGGER用户界面-添加卷曲示例，并禁用&quot；试用&quot；按钮 [英] Swagger UI - Add curl example with the "try it out" button disabled

问题描述

我正在使用Swagger UI为自定义REST API创建文档。

我禁用了"试用"按钮，因为我不需要它，但我希望显示每个请求的cURL命令。

有没有一种方法可以在不激活试用按钮的情况下显示它？或者在YAML文件中添加一些内容，以显示其中包含自定义文本的另一个div？

推荐答案

有没有一种方法可以在不激活"；试用按钮的情况下显示它？

不。Swagger UI的cURL命令生成器取决于"；试用"；可用性，因为命令是根据用户在"；试用"；期间指定的特定参数值生成的。

或者可能在YAML文件中添加一些内容，以显示其中包含自定义文本的另一个div？

您可以添加使用description操作字段来添加详细信息，如代码示例。说明支持Markdown格式设置。

paths:
  /something:
    get:
      summary: Get something
      description: >-
        Detailed description goes here.


        And here's some code:

            curl https://example.com/something -H "Accept: application/json"

      responses:
        200:
          description: Successful response

这篇关于SWAGGER用户界面-添加卷曲示例，并禁用&quot；试用&quot；按钮的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！