我对编写API和Swagger都是陌生的,而在使Swagger文档与我的API匹配方面遇到了问题。
尤其是,某些端点本质上会返回一个关联数组,例如下面的JSON(在result-> users下):
{
"result": {
"users": {
"1": {
"customerName": "Test Customer",
"shortCode": "Testc"
},
"2": {
"customerName": "Fake Customers",
"shortCode": "Fake"
},
"3": {
"customerName": "Unknown",
"shortCode": "UKN"
},
"-1": {
"customerName": "My Company",
"shortCode": null
}
}
}
}
在此示例中,数字代表用户ID,具体取决于返回的用户。
我们如何在Swagger中表示这一点?甚至有可能吗?
或者,这是否是错误的做法,是否应将ID作为属性移到对象内?