Swagger 모델 섹션은 어떻게 사용합니까?

Question

Swagger API 문서에는 API 개체 배열 옆에 json 내부에 모델 개체 항목이 있지만 이에 대한 설명서가 없습니다. 이 "모델"부분을 어떻게 사용할 수 있습니까?

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

    ... 

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

Answer 1

모델은 변수 및 속성이있는 java의 POJO 클래스와 비슷합니다. 모델 섹션에서는 사용자 정의 클래스를 정의 할 수 있으며 데이터 유형으로 참조 할 수 있습니다.

당신은 dataType와의 하나 개의 매개 변수가 애완 동물하고 애완 동물이 중첩 된 가질 수

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

다음과 같이 모델에 정의되어있는 다음 매개 변수 섹션에서

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

아래에 표시되는 경우 모델에 대한 자세한 내용은 Swagger PetStore example

S 모델은 수업과 비슷합니다.