Come si usa la sezione dei modelli Swagger?

Question

All'interno della documentazione dell'API Swagger, all'interno di JSON, accanto all'array apis, è presente una voce dell'oggetto modello ma non la documentazione. Come posso usare questa parte "modelli"?

Answer 1

I modelli non sono altro che come le tue classi POJO in java che hanno variabili e proprietà. Nella sezione dei modelli puoi definire la tua classe personalizzata e puoi riferirla come tipo di dati.

Se vedi sotto

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

Qui nella sezione dei parametri che hanno un parametro che è dataType è Pet e pet è definito nei modelli, come di seguito

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

È possibile hanno nidificato modelli, per ulteriori informazioni vedi Swagger PetStore example

S o i modelli non sono altro che classi simili.