Definir formatos de respuesta de los métodos
Resumen
Los formatos de salida permiten definir uno o más formatos de respuesta en los métodos de su API.
Los formatos de salida pueden ser mútiples en formato JSON, aunque también puede exponer los datos en CSV y XML.
Configurar formatos
Al crear un método deberá definir uno o múltiples formatos de respuesta. Los formatos de respuesta permiten definir el output de la solicitud, es decir, la respuesta que entregará el método ante una solicitud.
Una vez seleccionada la vista de datos, deberá definir los formatos de salida y sus plantillas.
Las plantillas de salida o output permiten definir la respuesta de salida para el formato seleccionado.
Agregar formatos
Para agregar un formato haga clic sobre el botón Agregar formato.
Puedes seleccionar entre los formatos disponibles o puedes crear un nuevo formato.
Si agregas un nuevo formato debes ingresar un nombre. Recuerda que el nombre debe ser descriptivo del formato entregado y será utilizado en el enpoint de la solicitud al método.
Agregar y editar plantillas
Para definir una nueva salida seleccione el formato deseado y Nueva plantilla. También podrá seleccionar una plantilla existente y copiarla para reutilizarla en su nuevo método.
Las plantillas de salida se definen mediante código de
jinja templates.
En la misma ventana, al crear o editar plantilla, podrá acceder a las referencias que le permitirán invocar los resultados de su vista de datos.
Para conocer más sobre las plantillas lea el artículo
Cómo trabajar con las plantillas para definir la salida de los métodos
Cabeceras de la respuesta
En el editor del método, el bloque Configurar cabeceras de la respuesta agrega cabeceras HTTP a lo que devuelve el método, para todos sus formatos. Elija o escriba el nombre en Cabecera (la lista trae cabeceras estándar, como
Content-Type o X-Total-Count, y acepta nombres nuevos), escriba el Valor y haga clic en Agregar Cabecera. Cada cabecera agregada queda en una lista debajo, donde puede editarla o quitarla.El valor puede ser un literal o una expresión Jinja que use el resultado o los parámetros del método, por ejemplo
{{ result.parameters.account }}. Las cabeceras se aplican después de renderizar la plantilla del formato: una cabecera Content-Type reemplaza la que trae el formato (por defecto application/json para json, application/xml para xml y text/csv para csv). Si el valor queda vacío o la expresión falla, esa cabecera no se envía.No confunda este bloque con el campo Tipo de Contenido de los detalles del método: ese es el content type que el método exige en la solicitud entrante (application/json, text/xml, multipart/form-data o application/x-www-form-urlencoded) y, vacío, no se valida.