Postman API Builder

Postman permite generar una API a partir de un swagger

Postman nos permite generar una API a partir de un swagger, crear la colección automáticamente y hacer la integración con sus test, mocks, así como la sincronización mediante github, que nos permite llevar un control de versiones. También crea una documentación básica y una monitorización de la API. 

Odoo image and text block

Crear una API y definir un esquema

Para crear una API tenemos que logearnos en Postman e ir a la pestaña de APIs, pulsando el botón de New Api o Create an Api.

Introducimos el nombre de la api, la versión, el esquema a utilizar y finalizamos pulsando el botón de Create API.

En este punto podemos definir nuestro propio esquema o importarlo desde un swagger.

Por defecto, Postman nos genera un esquema básico en la especificación OpenApi 3.0, en formato JSON, valores que se pueden cambiar cuando creamos nuestra API.

Para editar el esquema tenemos que ir a la pestaña Define donde tendremos acceso al esquema básico autogenerado, cambiando los campos correspondientes.

En la pestaña Develop podremos añadir un Environment definido previamente o bien crear un servidor mock y la documentación si es necesario.


Odoo - Sample 1 for three columns

Importar un swagger

Para importar un swagger, seguimos los pasos previos de creacción de una API y en la ventana de definición seleccionamos el esquema a importar y pulsamos Create API. 

Indicamos el tipo y formato del esquema que vamos a importar.

En la pestaña Define podemos revisar el esquema y hacer las modificaciones oportunas, antes de validarlo. Una vez validado lo guardamos pulsando en Save


Odoo - Sample 3 for three columns


Generar la colección

Una vez definido y validado el esquema, podemos generar la colección pulsando en Generate Collection, donde especificamos un nombre, el propósito de la colección y finalizamos pulsando en Generate Collection & Continue. 

Podemos ver la colección creada en la pestaña Collections.

Odoo image and text block

Añadir entornos

Para añadir un Environment antes deberá haber sido creado en la la sección environments de Postman. Para utilizarlo, pulsaremos en el icono correspondiente y pulsaremos Add.

Una vez añadido, en la pestaña Develop podemos seleccionarlo en la sección Environments.



Generar documentación

La documentación se genera automáticamente cuando creamos  la nueva API, siempre que lo hayamos específicado en el proceso de creación y tenemos acceso a ella en la pestaña Develop.

Test

Vamos a la pestaña de Test, donde podemos añadir test a cada uno de los endpoints o test de integración con otras APIs.


Odoo text and image block
Odoo image and text block

Agregar un mock

En Develop pulsamos en añadir o crear un nuevo Mock Server.

Para agregar un mock server primero tenemos que crear una colección o bien importar una colección ya existente.

Damos un nombre al Mock Server, configuramos un entorno y definimos si queremos que sea privado (en este caso habrá que definir una variable x-api-key en el header) o público y si queremos que lo guarde como variable de entorno URL.

Nos devolverá la url del Mock Server.

Seleccionamos el nuevo entorno en la sección de Develop-Environmments.

Ahora podremos comunicarlos con el mock-server usando el path: {{url}}

Monitorización

Vamos a la pestaña Observe y añadimos un nuevo Monitor.

Elegimos la colección que queremos monitorizar.

Configuramos los parámetros de monitorización, añadiendo un nombre, versión, entorno y frecuencia y pulsamos Create Monitor.

Finalmente podemos añadir más colecciones para monitorizar, añadir test customizados o ir a la ventana de monitorización, en la Web Dashboard, donde lo iniciamos.

Aquí, después de refrescar la ventana, podemos ver las llamadas hechas en toda la API o bien a un endpoint concreto.

Desde el propio Postman podremos entrar en la sección Reports (opción de pago).

Tenemos información sobre el número total de APIs, las APIs, activadas, información sobre el Workspace, y gráficos detallados de las llamadas.



Odoo text and image block
Odoo image and text block

Control de versiones e integración Git

Para cambiar la versión de la API, dentro de la pestaña Define pulsamos en Show All Versions.

Aquí vemos la versión actual y podemos crear una versión con recoja los últimos cambios implantados y definir los elementos que queremos actualizar.

En la sección Define pulsamos en Connect Repository.

Primero, en nuestro github necesitamos generar un nuevo Token, para eso iremos a Settings-Personal Access Token.

Este token lo usaremos para conectar nuestro Postman con Github y configuramos la API que queremos sincronizar y el repositorio de destino.

Elegiremos la versión de la API que queremos sincronizar pulsando en Add API Version.
Introducimos versión, rama, directorio y nombre del archivo.
Ahora podemos ver como nuestra API se sincroniza con GitHub.

Blog realizado por Alberto González

Leave a comment

You must be logged in to post a comment.