Cómo 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
Related Articles
Aplicar formatos de datos en la vista de datos
Resumen Los formatos de datos permiten modificar los valores de números y fechas sobre las columnas de las vistas de datos y configurar cuando el contenido es de tipo JSON. Para aplicar un formato debe seleccionar la opción Configurar tipo de datos y ...Cómo definir las rutas a los métodos: buenas prácticas
Resumen La definición de rutas o paths debe ser consistente con los recursos o entidades a los que refiere el método. A continuación se indican ciertas buenas prácticas para considerar en la definición de rutas. Un repaso Antes de continuar, ...Cómo definir respuestas de error personalizadas
Resumen Así como puedes definir formatos y plantillas para las respuestas exitosas de la solicitud al método, puedes definir plantillas de error para cada formato que hayas agregado y para cada tipo de error conocido. Configurar plantillas de error ...Qué es una vista de datos
Resumen La plataforma no requiere de un proceso ETL off-line para extraer los datos desde los orígenes, sino que asociadas a la vista se encuentran un conjunto de reglas que el motor de datos interpreta para consultar la fuente a demanda o ...Crear métodos de APIs
Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...