< Volver al curso

7.Crear una API Specification en AnyPoint Platform


En esta clase os voy a enseñar cómo crear una API Specification en Anypoint Platform, utilizando como lenguaje RAML 1.0.

Una API Specification sirve para detallar toda la información y recursos que la API expone en un lenguaje legible por humanos y máquinas. El motor de la API se diseña en las Mule Application con los WorkFlows (Flows y Subflows), mostrados en clases anteriores, que se ajustan al «menú» que presenta la API Specification.

Para crear la estructura de la API se utiliza RAML 1.0, que es un lenguaje de modelado de APIs muy simple, estructurado y conciso, en esta clase vamos a realizar la API Specification basándonos en la estructura de American Flights API .

Un fragmento de código

A continuación os muestro un fragmento del código que vamos a implementar en la clase.

Si os fijáis tenemos 2 recursos «/flights» y «/{ID}» que se podrán llamar citándolos en la URL que da el servicio, a estos recursos se les llama endpoints.

Un ejemplo sería nombredelservicio.com/flights , en RAML cuando se quiere añadir algún método, atributo o parámetro dentro de un objeto, en este caso el endpoint «flights», se utiliza la tabulación para definir la jerarquía, y sí, algunos estaréis pensando que es igual que Python.

También podemos observar que el segundo recurso «/{ID}»  está encerrado por {} esperando un valor. En la llamada el endpoint deberá contener el identificador específico que nos interese obtener la información, el valor que está esperando se le llama URI Parameter (recordad que nosotros pasamos a nombrar URL a las URI para estar más familiarizados con el concepto).

Al editor de API Specification se le llama API Designer y está estructurado por:

 

Finalmente, probaremos los métodos que hemos creado en nuestra primera API Specification desde API Console habilitando la opción de «burla» Mocking Service. Recordad que la opción de burla nos proporcionaba un recurso para poder realizar pruebas sin necesidad de publicar la API.

 

Si quieres saber más o necesitas ayuda personalizada, puedes suscribirte a mis servicios en el siguiente enlace

➡️ SUSCRIBIRSE A INGENIERO BINARIO ⬅️

Sin más, ¡dentro vídeo!

Actualización para la nueva versión de Anypoint Platform (2024)


Clases del curso


 

< Volver al curso