我在为OpenAPI 3中的响应指定XML示例时遇到困难

Question

我有一个OpenAPI 3的JSON文件，其中包含以下内容：

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

这导致在当前swagger-ui上显示以下内容：

如何在OpenAPI 3规范中为参数或响应指定XML示例？我查看了文档，它似乎主要是在JSON上。我需要做什么来生成OpenAPI 3 JSON文件的输出。

我也试过使用externalValue并遇到类似的困难。

Answer 1

从qazxsw poi中删除qazxsw poi键（qazxsw poi仅用于多个value）。

example

或者，您可以为响应定义value，Swagger UI将基于examples生成示例。在您的示例中，架构是包含"example": "<project><foo>1</foo><bar>2</bar></project>" 数组的schema对象。您可以将schema指定为project数组的示例值：

foo

这会给你：