method - ¿Cómo uso la sección de modelos swagger?

swagger tags

Question

Dentro de la documentación de la API de Swagger, hay una entrada de objeto modelo dentro del json junto a la matriz de apis, pero no hay documentación al respecto. ¿Cómo puedo usar esta parte de "modelos"?

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

   ...

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

Answer 1

Los modelos no son más que como tus clases de POJO en java que tienen variables y propiedades. En la sección de modelos puede definir su propia clase personalizada y puede referirla como tipo de datos.

Si ves abajo

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

Aquí, en la sección de parámetros, tiene un parámetro cuyo tipo de datos es Pet y pet se define en los modelos como se muestra a continuación

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

Puede tener modelos anidados, para más información vea el ejemplo de Swagger PetStore

Así que los modelos no son más que clases.