Swagger UI - 更新表单按钮文本

Question

我有一个包含以下内容的 YAML 文件：

    - name: parameters
      in: query
      required: true
      description: ""
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string

在 Swagger UI 中，它允许用户单击一个按钮来添加单独的参数。例子：

但是，我希望该按钮可以显示其他内容.. 例如 Add a Parameter 和文本框可以显示 single parameter 这样的内容，这样用户就不会感到困惑并添加多个参数在单个文本框中。

我正在使用独立的 swagger ui 包，我什至看不到这个按钮是在哪里生成的。看起来它是生成按钮的反应（我已经在 chrome 中检查过），但我看不到如何编辑它。

这可能吗？

Answer 1

要更改输入框中的文本，请在参数 schema 中添加一个 example:

      schema:
        type: array
        items:
          type: string
          example: single parameter  # <--------

您还可以添加数组级示例：

      schema:
        type: array
        items:
          type: string
          example: single parameter
        example:     # <--------
          - param 1
          - param 2

这将首先显示多个输入框，以便更清楚地表明每个输入都采用单个值：

悬停的“添加...项目”按钮文本已硬编码在 Swagger UI 源代码中：
https://github.com/swagger-api/swagger-ui/blob/master/src/core/json-schema-components.jsx#L269

要更改它，您必须分叉并重建 Swagger UI 并使用您的分叉版本而不是标准版本。

Swagger UI - 更新表单按钮文本

Swagger UI - Update form button text

yaml

swagger-ui

openapi