首页 > 解决方案 > 如何在 OpenAPI/Swagger 的 JSON 请求中使用 XML 作为数据字段?

问题描述

我需要创建一个 REST 端点,它将使用一个 JSON 请求,但这个 JSON 对象有一个数据字段,它是一个 XML 文件。

如下例所示,Customer是可以保存 JSON 格式(AddressJson)或 XML 格式(AddressXML)地址的请求对象。

谁能建议我如何使用 XML 格式的地址(AddressXML)?最后,我想要一个 OpenAPI (Swagger) 表示*。

"Customer": {
  "description": "A problem object",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "name of the customer",
      "example": "null"
    },
    "AddressJson": {
      "$ref": "#/definitions/AddressJson/"
    },
    "AddressXML": {
      "type": "XML",
      "description": "address of the customer, specifically in XML format"
    }
  }
}

标签: javaspringswagger-2.0openapiswagger-codegen

解决方案


推荐阅读