如何使用swagger模型部分？
如何使用swagger模型部分？
提问于 2013-03-04 16:43:01
在Swagger API文档中，除了API数组之外，json中还有一个模型对象条目，但是没有关于它的文档。如何使用这个“模型”部分？
{
apiVersion: "0.2",
swaggerVersion: "1.1",
basePath: "http://petstore.swagger.wordnik.com/api",
resourcePath: "/pet.{format}"
...
apis: [...]
models: {...}
}回答 1
Stack Overflow用户
回答已采纳
发布于 2013-03-04 18:03:35
模型就像java中的POJO类，它有变量和属性。在models部分中，您可以定义自己的自定义类，并且可以将其称为数据类型。
如果你在下面看到
{
"path": "/pet.{format}",
"description": "Operations about pets",
"operations": [
{
"httpMethod": "POST",
"summary": "Add a new pet to the store",
"responseClass": "void",
"nickname": "addPet",
"parameters": [
{
"description": "Pet object that needs to be added to the store",
"paramType": "body",
"required": true,
"allowMultiple": false,
"dataType": "Pet"
}
],
"errorResponses": [
{
"code": 405,
"reason": "Invalid input"
}
]
}在参数部分，有一个参数who's dataType is pet ，以及在模型中定义宠物，如下所示
{
"models": {
"Pet": {
"id": "Pet",
"properties": {
"id": {
"type": "long"
},
"status": {
"allowableValues": {
"valueType": "LIST",
"values": [
"available",
"pending",
"sold"
]
},
"description": "pet status in the store",
"type": "string"
},
"name": {
"type": "string"
},
"photoUrls": {
"items": {
"type": "string"
},
"type": "Array"
}
}
}
}}您可以使用嵌套模型，有关更多信息，请参阅Swagger PetStore example
所以模型就像类一样。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/15197579
复制相关文章
相似问题
腾讯云开发者
