我在为OpenAPI 3中的响应指定XML示例时遇到困难
我在为OpenAPI 3中的响应指定XML示例时遇到困难
提问于 2019-02-27 21:34:04
我有一个用于OpenAPI 3的JSON文件，它包含以下内容：
"trait_hasProjectResponse_200": {
"description": "",
"content": {
"application/xml": {
"example": {
"value" : "<project><foo>1</foo><bar>2</bar></project>"
}
}
}
},这将在当前的swagger上显示如下内容：
如何在OpenAPI 3规范中为参数或响应指定XML示例？我已经查看了文档，它似乎是最拖沓的，主要是关于JSON的。我需要做什么来完成生成OpenAPI 3 JSON文件的输出。
我也尝试过使用externalValue，也有类似的困难。
回答 1
Stack Overflow用户
回答已采纳
发布于 2019-03-01 09:43:09
从value中删除example键(value仅用于多个examples)。
"example": "<project><foo>1</foo><bar>2</bar></project>"或者，您可以为响应定义一个schema，Swagger将根据schema生成示例。在您的示例中，架构是一个包含project数组的foo对象。可以将[1, 2]指定为foo数组的示例值：
"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]
}
}
}
}
}这将给你：
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/54914829
复制相关文章
相似问题
腾讯云开发者
