Construye y publica una API desde cero

Construye y publica una API desde cero

Resumen

En este artículo encontrarás como utilizar la plataforma para construir, publicar y gestionar tu primera API.

Para poder seguir estos pasos necesitas un origen de datos. Si no, puedes utilizar este ejemplo.

Ejemplo

En este artículo utilizaremos un ejemplo a partir de un archivo Excel. Recuerda que puedes utilizar diferentes tipos y formatos de orígenes de datos.



El  objetivo es exponer una API con un método GET que permita buscar empleados según fecha de nacimiento, nombre, apellido, género y fecha de contratación.

El resultado de esta guía puede verse aquí.

Video





Crear una API desde cero

Configurar origen de datos

Para configurar el origen de datos debes ir a Workspace > Orígenes de datos > Desde archivo.

Arrastra o selecciona el archivo desde tu computadora, y haz clic en Continuar.



En el segundo paso debes completar el título y descripción para poder luego reconocer a tu origen de datos. Además, puedes seleccionar una categoría para organizar tus orígenes de datos.




Crear vista de datos

Las vistas de datos permiten seleccionar, transformar tus datos y configurar validaciones de parámetros.

Una vez creado el origen de datos, selecciona Crear vista > Usando un asistente.



Al crear la vista de datos, se mostrará esta pantalla. En el caso de los archivos Excel, como el de este ejemplo, podrás seleccionar la tabla u hoja sobre la cual operará la vista de datos.





Selecciona la tabla completa, haciendo clic en la celda de la esquina superior izquierda.





Selecciona la primera fila como cabeceras y edita sus nombres. La selección de cabeceras es importante para diferenciarla del resto de los datos y poder hacer un tratamiento diferente al momento de contruir la respuesta de tu API.




Agrega filtros de datos sobre las columnas de la vista. Por ejemplo, selecciona la Columna B, el tipo de operación y el operador Parámetro.

Luego define el nombre del parámetro, que será el nombre del parámetro del método de la API. Puedes agregar una descripción y un valor por defecto.

Además puedes agregar reglas de validación sobre los valores, para indicar si debe ser de tipo texto, número o fecha, con diferentes opciones de configuración en cada caso.


Si deseas configurar un comodín o wildcard como valor por defecto debes ingresar como valor un asterisco entre corchetes (square brackets): [*]


Una vez que hayas seleccionado la tabla completa, las cabeceras y agregado los filtros de datos se mostrarán todas las configuraciones a la izquierda.


Ahora, haz clic en Continuar y modifica los metadatos: en este caso modificamos los metadatos del origen de datos para representar con claridad la configuración de la vista de datos.





En este ejemplo utilizaremos un solo orígen de datos para los entornos de la API, pero recuerda que puedes configurar diferentes orígenes de datos para cada entorno al configurar la vista de datos. Conoce cómo configurar el multi-entorno.



Para más información sobre las vistas de datos accede a esta sección.


Configurar API, versión y método

Crear API

Para crear una API debes ir a APIs > Nueva API.

Ingresa un nombre y descripción, selecciona un ícono y una categoría.


Define los SLO


Define los límites,tiempo máximo de respuesta,  caché y cantidad máxima de filas. Luego, guarda tu API.


Crear version

Una vez que hayas creado la API, crea una versión.




Agregar métodos



Ahora puedes agregar un método a la versión de tu API. Al agregar el método deberás seleccionar la vista de datos, configurar el tipo de solicitud y ruta, agregar una descripción, diccionarios de datos y otras configuraciones.




Puedes definir múltiples formatos de salida para el método de tu API. Además, puedes seleccionar el formato RAW que no realizará transformaciones sobre la respuesta que entregue el origen de datos.




Puedes además definir la privacidad de tu método.



Para más información accede a esta sección.

Publicar API

Publica la versión de tu API para que esté disponible en el portal para desarrolladores y pueda comenzar a ser ejecutada.



Compartir acceso a los métodos

Si definiste métodos privados, deberás compartirlos con los usuarios que correspondan para que puedan acceder a la documentación en el portal y puedan comenzar a utilizarlos.





Portal para desarrolladores

Probar API publicada

Una vez que hayas publicado la versión de tu API, ingresa al portal y prueba los métodos para validar que funciona como esperas.




Para más información accede a esta sección.


Gestionar API

Control de cambios

Si realizas alguna modificación en los recursos del Workspace (Orígenes de datos, vistas o APIs) se generarán versiones en borrador que debes publicar para que los cambios aplicados impacten sobre el portal y gateway. Para más información accede a este artículo.

Gestión de entornos

Si deseas configurar diferentes entornos para los métodos de tus APIs puedes hacerlo al configurar la vista de datos. Conoce cómo configurar el multi-entorno.

Versionado

Puedes agregar nuevas versiones a tu API a medida que lo necesites. También puedes despublicar las versiones antiguas si quieres deperecarlas.

Panel de estadísticas

En Workspace puedes acceder a la sección de Estadísticas para conocer el consumo de las APIs por códigos de respuesta, usuarios y APIs en un período de tiempo, mediante gráficos. Continua leyendo para conocer cómo consultar estos datos mediante APIs.




APIs Administrativas

Las APIs administrativas te permitirán conocer las estadísticas, documentos de auditoría y niveles de servicio de tus APIs. Conoce más en esta sección.

Estadísticas

Si quieres integrar los datos de estadísticas a tus sistemas o programas de visualizaciones puedes utilizar la API de Estadísticas, disponible en el portal de APIs Administrativas.

Auditoría

Puedes conocer el detalle de las solicitudes recibidas y respuestas entregadas mediante la API de auditoría disponible en el portal de APIs Administrativas.

Monitoreo

Si tu cuenta tiene habilitado el monitoreo de los métodos, puedes conocer sus niveles de disponibilidad mediante la API de monitero en el portal de APIs Administrativas.






    • Related Articles

    • Crear una cuenta de Vor-Tex

      Para registrarte en Vor-Tex debes ingresar a https://workspace.vor-tex.io/signup/ Primero deberás ingresar tu email. Luego, recibirás este mensaje y un email en la dirección ingresada con un enlace para continuar el proceso de registro. Al acceder al ...

    • Gestiona tus APIs ya construidas

      Resumen En este artículo encontrarás como utilizar la plataforma para gestionar tus APIs REST/json ya construidas y utilizar las capacidades de seguridad, estadísticas, auditoría, monitoreo y otras que ofrece la plataforma. Para poder seguir estos ...