Warning: file_get_contents(/data/phpspider/zhask/data//catemap/6/opengl/4.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Swagger 如何在OpenAPI中定义对象的XML数组?_Swagger_Openapi_Swaggerhub - Fatal编程技术网

Swagger 如何在OpenAPI中定义对象的XML数组?

Swagger 如何在OpenAPI中定义对象的XML数组?,swagger,openapi,swaggerhub,Swagger,Openapi,Swaggerhub,我正在使用OpenAPI3.0和SwaggerHub设计一个API。My API有一个GET端点,该端点以XML格式返回员工数组: 001 史蒂文 1-541-754-3010 steven@yourcomany.com 002 做记号 1-551-754-3010 mark@yourcomany.com 以下是迄今为止我的OpenAPI YAML文件: openapi:3.0.0 信息: 标题:一般性文件 版本:“1.0” 联系人: 电邮:developer@email.com 说明:>

我正在使用OpenAPI3.0和SwaggerHub设计一个API。My API有一个GET端点,该端点以XML格式返回员工数组:


001
史蒂文
1-541-754-3010
steven@yourcomany.com
002
做记号
1-551-754-3010
mark@yourcomany.com
以下是迄今为止我的OpenAPI YAML文件:

openapi:3.0.0
信息:
标题:一般性文件
版本:“1.0”
联系人:
电邮:developer@email.com
说明:>
#导言
本文档描述了可用API的列表\
路径:
/雇员:
获取:
描述:这将返回JSON和XML格式的员工信息
响应:
200:
$ref:“#/components/responses/employeesAPI”
组件:
响应:
员工SAPI:
描述:这将返回有关员工的信息
内容:
应用程序/xml:
模式:
$ref:“#/components/schemas/EmployeesInfo”
模式:
雇员:
类型:对象
必修的:
-埃皮德
-名字
-流动的
-电子邮件ID
特性:
EmpId:
类型:字符串
示例:此处显示员工id
描述:员工id
姓名:
类型:字符串
示例:此处显示员工姓名
描述:员工姓名
流动电话:
类型:字符串
示例:员工手机在这里
说明:员工手机
EmailId:
类型:字符串
示例:员工电子邮件发送到此处
说明:员工电子邮件
雇员信息:
类型:对象
必修的:
-雇员
特性:
雇员:
$ref:“#/components/schemas/Employee”
xml:
姓名:EmployeesInfo
#由API自动模拟插件添加
服务器:
-描述:SwaggerHub API自动模拟
网址:https://virtserver.swaggerhub.com/name2200/test/1.0
问题在于,SwaggerHub中显示的XML响应示例与预期的响应XML不匹配


如何正确定义对象的XML数组?

如下更改模式
EmployeesInfo
应定义为数组,并具有=
true
。还要确保每个模式都使用相应的xml标记名指定
xml.name

组件:
...
模式:
雇员:
类型:对象
...
xml:
姓名:雇员
雇员信息:
类型:数组
项目:
$ref:“#/components/schemas/Employee”
xml:
姓名:雇员
是的

Swagger UI将显示如下响应示例(此示例是根据响应模式自动生成的):


员工id在这里
员工姓名在这里
员工手机在这里
员工电子邮件发到这里
如果要显示自定义示例,例如包含2名员工的阵列,请添加自定义响应示例:

组件:
响应:
员工SAPI:
描述:这将返回有关员工的信息
内容:
应用程序/xml:
模式:
$ref:“#/components/schemas/EmployeesInfo”
#响应XML的自定义示例
例如:|-
001
史蒂文
1-541-754-3010
steven@yourcomany.com
002
做记号
1-551-754-3010
mark@yourcomany.com

是否有一个
OpenAPI
注释可以对我的Java模型执行此操作?@payne我不知道。拜托,我现在提出了这个问题: