Làm cách nào để sử dụng phần mô hình vênh vang?

Question

Bên trong tài liệu API Swagger có bên trong json bên cạnh mảng apis một mục đối tượng mô hình nhưng không có tài liệu về nó. Làm thế nào tôi có thể sử dụng phần "mô hình" này?

{ 
    apiVersion: "0.2", 
    swaggerVersion: "1.1", 
    basePath: "http://petstore.swagger.wordnik.com/api", 
    resourcePath: "/pet.{format}" 

    ... 

    apis: [...] 
    models: {...} 
} 

Answer 1

Mô hình không gì khác ngoài các lớp POJO trong java có biến và thuộc tính. Trong phần mô hình, bạn có thể định nghĩa lớp tùy chỉnh của riêng mình và bạn có thể tham chiếu nó làm kiểu dữ liệu.

Nếu bạn thấy bên dưới

 { 
     "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" 
        } 
       ] 
      } 

đây trong phần tham số đó có một số người là datatype là Pet và vật nuôi được định nghĩa trong mô hình như sau

{ 
"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" 
      } 
     } 
    } 
}} 

Bạn có thể đã lồng nhau mô hình, để biết thêm thông tin, hãy xem Swagger PetStore example

S o các mô hình không là gì ngoài các lớp học.