Swagger UI 在 XML 中显示地图示例

Question

您好，我有以下架构，其中包含一个字符串映射，并且包含了一些示例。 JSON 显示有效，但 XML 显示无效。有没有办法解决这个问题？

paths:
  /somePath:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SomeMap'
            application/xml:
              schema:
                $ref: '#/components/schemas/SomeMap'
components:
  schemas:
    SomeMap:
      type: object
      additionalProperties:
        type: string
      example:
        'key_1': 'value_1'
        'key_2': 'value_2'
        'key_3': 'value_3'

JSON中的输出：

{
  "key_1": "value_1",
  "key_2": "value_2",
  "key_3": "value_3"
}

XML中的输出：

<?xml version="1.0" encoding="UTF-8"?>
<SomeMap>
    <additionalProp>string</additionalProp>
</SomeMap>

XML 中的预期输出：

<?xml version="1.0" encoding="UTF-8"?>
<SomeMap>
    <key_1>value_1</key_1>
    <key_2>value_2</key_2>
    <key_3>value_3</key_3>
</SomeMap>

使用 Swagger 3.0。

Answer 1

改为添加 XML 示例作为响应示例：

paths:
  /somePath:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SomeMap'
            application/xml:
              schema:
                $ref: '#/components/schemas/SomeMap'
              example: |
                <?xml version="1.0" encoding="UTF-8"?>
                <SomeMap>
                  <key_1>value_1</key_1>
                  <key_2>value_2</key_2>
                  <key_3>value_3</key_3>
                </SomeMap>

Swagger UI 在 XML 中显示地图示例

Swagger UI to show Map example in XML

swagger

swagger-ui

openapi