代码之家 › 专栏 › 技术社区 › Loren Cahlander

我很难在OpenAPI 3中为响应指定XML示例

openapi swagger-ui

Loren Cahlander · 技术社区 · 7 年前

我有一个OpenAPI 3的JSON文件,包含以下内容:

            "trait_hasProjectResponse_200": {
                "description": "",
                "content": {
                    "application/xml": {
                        "example": {
                            "value" : "<project><foo>1</foo><bar>2</bar></project>"
                        }
                    }
                }
            },

0 回复 | 直到 7 年前

Helen 7 年前

拆下 value 钥匙从 example 价值 examples

"example": "<project><foo>1</foo><bar>2</bar></project>"

或者,可以定义 schema 对于响应,Swagger UI将根据 架构 . 在您的示例中,模式是 project foo [1, 2] 福 数组:

  "components": {
    "responses": {
      "trait_hasProjectResponse_200": {
        "description": "",
        "content": {
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/project"
            }
          }
        }
      }
    },
    "schemas": {
      "project": {
        "type": "object",
        "properties": {
          "foo": {
            "type": "array",
            "items": {
              "type": "integer"
            },
            "xml": {
              "wrapped": false
            },
            "example": [1, 2]
          }
        }
      }
    }
  }

这将为您提供:

XML response example generated by Swagger UI based on the response schema

推荐文章

Mike · Swagger无法加载

2 年前

Guilherme G · SWAGGER BUG:只允许一个参数(!已解决)

2 年前

Tanisha Sethi · Swagger中的错误消息“未提供必填字段”

2 年前

Ibanez1408 · JSON和UI端点的核心托管Blazor WASM Swagger返回404

2 年前

PhoenixAshes · 中的自定义swagger ui过滤器插件(opsFilter)。NET Core应用程序

3 年前

SinaMN75 · 最小API的Swagger

3 年前

Sanal M · swagger ui不适用于没有客户端的jhipster应用程序

3 年前

stosik · 限制模式定义的自动生成OpenAPI Spring Boot

3 年前

Isaac Hatilima · Django Rest Framework+Swagger UI

3 年前

neo007 · Spring Boot-将API标记为尚未实现

3 年前