yaml - 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 中检查过它），但我看不到如何编辑它。

这可能吗？

标签： yamlswagger-uiopenapi

Answer 1

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

      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-架构组件.jsx#L269

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