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
Cómo trabajar con las plantillas para definir la salida de los métodos
Resumen Las plantillas de salida o output permiten definir cómo será la respuesta entregada al ejecutar un método de la API. Las plantillas se relacionan a formatos de salida. Configurar plantillas Para definir una nueva salida seleccione el formato ...Orígenes de datos desde servicios web REST/json
Resumen El conector a servicios web REST/JSON ofrece todas las capacidades necesarias para conectarse a este tipo de orígenes. Esta opción permite recolectar datos desde servicios web REST/JSON o configurar acciones de escritura, para luego crear ...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 ...Qué son los orígenes de datos
Resumen Los orígenes de datos son el punto de partida del flujo de los datos, a partir de los cuales se crearán vistas de datos y métodos de APIs. A continuación se detallan las caraceterísticas de los orígenes de datos. Algunos conceptos básicos ...Monetización de APIs
Resumen Una API monetizada es aquella en la cual su diseño y configuración tiene por objetivo generar ingresos mediante el cobro de dinero, incorporando un modelo de negocio cuyas definiciones delimitan cómo y cuánto pagarán los usuarios por consumir ...