Generate json struct of file Design

[vpino]

Se necesita generar dinamicamnete el archivo design. El cual es el que contiene toda la logica de la API que necesita el Usuario.

Esto se requiere que sea mediante un formulario sencillo, usable y accesible.

El archivo design esta compuesto por varios elementos:

• API: Contiene la informacion generica del servicio:

Ejemplo:

"api": 
        {
            "mainname": "CEHDUN",
            "title": "Standardized Set of Programs",
            "description": "A test of shit",
            "host": "localhost:8080"
        },

• Resources: Lista de recursos que contendra la API. La API puede contar con uno o varios recursos, esto dependera de lo complejo que lo requiera el usuario. El Resources esta compuesto:

  • namegroup: Nombre del recurso.
  • basepath: Ruta raiz que servira como base para los endpoints.
  • mediatype: Estructura de dato que sirve como respuesta de una peticion a un recurso. El recurso puede contar con uno o varios. Este esta compuesto por:
    • name: Nombre del mediatype.
    • type: Tipo de la respuesta.
    • descripcion: Descripcion corta.
    • attributes: LIsta de atributos que requiere la estructura. Esta llave esta formado por:
      • name: Nombre.
      • type: Tipo del atributo (string, boolean..)
      • descripcion: Descripcion corta.
      • required: Si es requerido o no (true o false).

Ejemplo de un mediatype:

"mediatype": 
                {
                    "name": "RoutineMedia",
                    "type": "application/json",
                    "description": "A routine of a CEHDUN",
                    "attributes":
                    [
                        {
                            "name": "id",
                            "type": "Integer",
                            "description": "Unique routine ID",
                            "required": true
                        },
                        {
                            "name": "href",
                            "type": "String",
                            "description": "API href for making requests on the routine",
                            "required": true
                        }
                   ]

• views: Clave del recurso donde se definen una lista de vistas genericas de respuesta parecidas a los mediatype. Esta compuesto por:
  • name: Nombre.
  • attributes: Lista de atributos. Los cuales estan compuesto por:
    • name: Nombre.
    • type: Tipo del atributo (string, boolean..)
    • descripcion: Descripcion corta.
    • required: Si es requerido o no (true o false).

Ejemplo de una view:

"views":
                    [
                        {
                            "name": "default",
                            "attributes":
                            [
                                {
                                    "name": "id",
                                    "type": "Integer",
                                    "description": "Unique routine ID",
                                    "required": true
                                },
                                {
                                    "name": "href",
                                    "type": "String",
                                    "description": "API href for making requests on the routine",
                                    "required": true
                                }
                            ]
                       }
                 ]

• actions: Son los endpoints que definen y manejan la logica de la API. Esta compuesto por:

  • name: Nombre
  • descripcion: Descripcion corta.
  • method: Metodo de la peticion (POST, DELETE, PUT, GET)
  • route: Ruta por la cual va a responder. (/show)
  • params: Lista de parametros. Estan compuesto por:
    • name: Nombre.
    • type: tipo.
    • descripcion: Opcional y corta.
  • payload: Estructura de datos que se utiliza como dato de entrada de un POST o como respuesta. Esta compuesta por:
    • name: Nombre.
    • attributes: Lista de atributos. Compuestos por:
      • name: Nombre.
      • type: Tipo del atributo (string, boolean..)
      • descripcion: Descripcion corta.
      • required: Si es requerido o no (true o false).
  • responses: Lista de respuestas que tendra disponible el action. En este momento se tiene preconfigurada dos por defecto: ok, NotFound

Con esto terminamos de explicar como esta compuesto el archivo DESIGN ahora mostramos un ejemplo completo real y funcional de un archivo ya generado.

 {
        "api": 
        {
            "mainname": "CEHDUN",
            "title": "Standardized Set of Programs",
            "description": "A test of shit",
            "host": "localhost:8080"
        },
        "resources":
        [
            {
                "namegroup": "routine",
                "basepath": "/routines",
                "mediatype": 
                {
                    "name": "RoutineMedia",
                    "type": "application/json",
                    "description": "A routine of a CEHDUN",
                    "attributes":
                    [
                        {
                            "name": "id",
                            "type": "Integer",
                            "description": "Unique routine ID",
                            "required": true
                        },
                        {
                            "name": "href",
                            "type": "String",
                            "description": "API href for making requests on the routine",
                            "required": true
                        },
                        {
                            "name": "name",
                            "type": "String",
                            "description": "Name of a routine",
                            "required": true
                        },
                        {
                            "name": "message",
                            "type": "String",
                            "description": "Message",
                            "required": false
                        }
                    ],
                    "views":
                    [
                        {
                            "name": "default",
                            "attributes":
                            [
                                {
                                    "name": "id",
                                    "type": "Integer",
                                    "description": "Unique routine ID",
                                    "required": true
                                },
                                {
                                    "name": "href",
                                    "type": "String",
                                    "description": "API href for making requests on the routine",
                                    "required": true
                                },
                                {
                                    "name": "name",
                                    "type": "String",
                                    "description": "Name of a routine",
                                    "required": true
                                },
                                {
                                    "name": "message",
                                    "type": "String",
                                    "description": "Message",
                                    "required": false
                                }  
                            ]
                        }
                    ]
                },
                "actions": 
                [
                    {
                        "name": "show",
                        "description": "Get routine by id",
                        "method": "GET",
                        "Route": "/:routineID",
                        "params": 
                        [
                            {
                                "name": "routineID",
                                "type": "Integer",
                                "description": "Routine ID"
                            }
                        ],
                        "payload": {},
                        "responses": 
                        [
                            {
                                "name": "OK"
                            },
                            {
                                "name": "NotFound"
                            }
                        ]
                    },
                    {
                        "name": "submit",
                        "description": "Post accepts a form encoded request and returns a form encoded response",
                        "method": "POST",
                        "Route": "/",
                        "params": [],
                        "payload": 
                        {
                            "name": "Routine",
                            "attributes":
                            [
                                {
                                    "name": "routineID",
                                    "type": "Integer",
                                    "description": "Routine ID",
                                    "required": true
                                },
                                {
                                    "name": "name",
                                    "type": "String",
                                    "description": "Name Routine name",
                                    "required": true
                                },
                                {
                                    "name": "activities",
                                    "type": "Integer",
                                    "description": "Number of activities",
                                    "required": true
                                }
                            ]
                        },
                        "responses": 
                        [
                            {
                                "name": "OK"
                            },
                            {
                                "name": "NotFound"
                            }
                        ]
                    }
                ]
            }
        ]
    }