Ciclo API First

Estando en la rama development, para realizar el testeo de nuestra API, tenemos habilitados los siguientes apartados:

Calidad en definición – sonarqube: #

En este apartado podemos visualizar el archivo de definición asociado a la API, así como la calificación de nuestra API.

Al acceder al menú, podemos ejecutar , actualizar así como editar la definición demuestra API. Tendremos la opción de reescanear la API en caso de haber realizado modificaciones en la definición, así como visualizar los errores y vulnerabilidades dentro del propio fichero para tener una visión más clara del problema.

Podremos hacer modificaciones en la definición de nuestra API directamente para posteriormente guardarlo, para ello debemos acceder a el apartado de “Definición”

En el icono de la hamburguesa disponemos de distintas opciones, como son ocultar los detalles de los errores, opción de descarga, subir un archivo para su actualización (dispone de un desplegable con dos opciones: archivo local o URL), mostrar vista de swagger, mostrar vista editor.

Si seleccionamos vista de “Editor” podremos más cómodamente editar el archivo en la propia herramienta y guardar estos cambios: :

Si seleccionamos vista de Swagger:

En la vista del Swagger, saldrán las reglas que hemos definido en nuestra guía de estilos y que no se han cumplido. Haciendo clic en el nombre de la regla, se abrirá una vista con la explicación de la regla seleccionada con un ejemplo de compilación correcta y otro de incorrecta.

Por otra parte, en caso de querer reemplazar el fichero, podemos hacer clic en el botón “Subir fichero”, donde se nos abrirá el siguiente diálogo para elegir el origen de importación.

También tenemos la posibilidad de descargarnos el fichero de la API actual mediante la opción “Descargar”. Esto resulta útil en caso de haber editado la definición desde API Quality, y se quiere tener una copia local con los últimos cambios realizados.

Mock server – microcks #

Se puede visualizar un desplegable con la clasificación del índice y de la puntuación.

Podemos lanzar nuestra stage así como actualizarla.

Al hacer clic en la URL nos redirige a la página de microcks.

Contract tests – swagger2postman #

Permite generar colecciones postman para realizar pruebas.

En este apartado podemos generar nuestras colecciones de Postman. Para ello debemos pulsar en el botón Configuración y luego en Generar colecciones.

Al pulsar, se abrirá un diálogo donde se nos pedirá, con los campos obligatorios, en primer lugar, dar nombre al Host que queremos generar, a continuación el Puerto. Así también tenemos la opción de generar estos endpoint solo de lectura, y por último hacer clic en botón crear.

Una vez generadas las colecciones, tendremos la opción de descargarlas mediante el botón Descargar colecciones. Si quisiéramos, también se puede editar un entorno.

Pruebas de calidad – newman #

Realiza tests en base a una colección de postman.

Para terminar el ciclo de testing de nuestra API, debemos hacer clic en configuración tenemos disponible el apartado Pruebas de calidad – “newman”.

Para ejecutar un test, pulsaremos el botón Ejecutar test.

Figura 80. Ejecutar test Newman

A continuación, se abrirá un diálogo donde deberemos incluir tanto el fichero json de la colección Postman a examinar, como el fichero de entornos asociado a la misma para realizar el test, una vez subidas podremos lanzarlo,y actualizarlo,

Una vez generado el reporte, se mostrará una vista como la siguiente donde examinar los resultados:

Figura 82 . Reporte de Newman generado

Microservicios #

API Quality permite generar el arquetipo correspondiente a la definición importada en un lenguaje concreto. Este microservicio se encontrará disponible en el repositorio de definición de la API.

Para generar el arquetipo, deberemos elegir entre los lenguajes disponibles en la herramienta, actualmente Java Spring Boot o C#. NET, y pulsar el botón Generar. Es importante que la definición contenga la estructura correcta para que se pueda generar el arquetipo; en caso contrario, se obtendrá un error.

Para ello hacer clic en configuración, nos llevará a un apartado donde podremos seleccionar en qué lenguaje queremos utilizar

Una vez generado el arquetipo, se habilitará el botón Descargar, que permite tener una copia local del proyecto base.

Despliegue en Api Manager – kong, Despliegue en Api Manager – mulesoft, Despliegue en Api Manager – wso2:v4, Despliegue en Api Manager – wso2:v3, Despliegue en Api Manager – aws #

El último apartado del ciclo API First es el de despliegue. Para desplegar una API elegiremos el API Manager en la que queremos desplegarla, pulsaremos en el menú, se desplegará la opción de “Ejecutar stage” para su despliegue.

Para desplegar una API, pulsaremos el botón Desplegar API:

Esto abrirá un diálogo donde deberemos seleccionar el API Manager, dependiendo del que elegimos se desplegarán otras opciones donde deseamos desplegar nuestra API. Visualermos también Backend service URL, el cual no es obligatorio.