Fase de diseño de las APIs: enfoque de Mulesoft

Como comentábamos en el artículo Ciclo de vida de las APIs: enfoque de Mulesoft, en el panorama actual las empresas necesitan tomar decisiones con rapidez y requieren una metodología que proporcione la flexibilidad necesaria para lograrla.

Para cubrir esas necesidades, Mulesoft ofrece una suite completa de herramientas que nos ayudarán durante todo el ciclo de vida de una API, consiguiendo nuestras metas más rápidamente que con el uso de otras tecnologías y reduciendo los tiempos.

El objetivo de este artículo es explicar cómo, dentro de este ciclo de vida, podemos cubrir las tareas a llevar a cabo en la fase de diseño con las herramientas proporcionadas por Mulesoft.

Diseño: Design Center

El primer paso que debemos dar a la hora de diseñar una API es el de crear la "interfaz/contrato" de la misma, decidiendo cuál será su aspecto y comportamiento antes de empezar a programar. Para ello, Mulesoft proporciona la herramienta Design Center:

Desde la cual podremos:

·        Definir la especificación de nuestra API en formato RAML / OAS

·        Definir los esquemas y ejemplos con los que contará nuestra API

·        Definir los ficheros que contienen las cabeceras de la API

·        Definir la estructura de carpetas que tendrá:

o   datatypes: carpeta que contendrá los esquemas de datos de E/S

o   examples: carpeta que contendrá los ejemplos de E/S de nuestra API

o   traits: carpeta que contendrá el archivo headers.raml

Además, la herramienta cuenta con la opción de autocompletado y sugiere en todo momento las etiquetas que es posible añadir en función del nivel en el que nos encontremos.

Una vez se haya completado la especificación y añadido todos los métodos / recursos necesarios, podremos probar nuestro diseño desde la parte de Mocking.

Simulación: Mocking Service

Dentro de la propia herramienta de Desing Center, Mulesoft pone a nuestra disposición un servicio de Mocking desde donde podremos simular cómo funcionaría nuestra aplicación y los tipos de datos de E/S con los que estamos trabajando:

Con el servicio de Mocking activo, Mulesoft también nos proporcionará una URL que podremos facilitar a los sistemas consumidores para que puedan ir validando si los datos y los tipos definidos para ellos cumplen con lo que se necesita. Mientras que los sistemas realizan estas comprobaciones y ejecutan pruebas de conectividad, nosotros podremos trabajar en la implementación de la API.

Feedback: Anypoint Exchange

Con nuestra especificación terminada, el siguiente paso será publicarla en el Marketplace Anypoint Exchange para que otros desarrolladores puedan ver en qué estamos trabajando.

Esto podremos hacerlo fácilmente pulsando el botón Publish que aparece dentro de Design Center a la hora de crear la especificación:

Para poder publicarla, deberemos indicar cuál es la versión de la API, así como la versión del Asset que vamos a publicar. Si todo ha ido bien, nos aparecerá una ventana avisando de que la publicación es correcta y de que podremos visualizarla en Anypoint Exchange.

Desde Anypoint Exchange también se nos permitirá:

• Acceder a la parte de Mocking
• Ver qué instancias de la API hay disponibles
• Crear / Editar un portal donde poder especificar, entre otras cosas, qué funcionalidades ofrece la aplicación, sistemas involucrados y códigos de error más comunes.

Completada la fase de diseño, el siguiente paso será importar nuestra especificación en Anypoint Studio para comenzar con la fase de implementación de la API.

Autora del artículo

Cristina Sánchez Ruiz, senior consultant de Consultoría Tecnológica de Deloitte