Primera aplicación de la API

Las API constituyen el centro neurálgico de las aplicaciones informáticas. Por eso es importante que los proveedores tengan claro lo que pueden ofrecer y que los consumidores tengan claro lo que quieren consumir. Un mejor conocimiento de las API garantiza un resultado excelente. API First consiste en establecer un acuerdo común entre proveedores y consumidores. Así, este diseño ayuda a ambas partes a estar en sintonía.

Cuando se adapta el enfoque API First, como desarrollador de API puede comenzar el desarrollo de la API con el contrato de API. Puedes trabajar en la parte de la aplicación en una fase posterior. Este planteamiento de dar prioridad al diseño de la API sobre su aplicación es beneficioso tanto para los proveedores como para los consumidores.

En los escenarios convencionales, los proveedores exponen las API a sus consumidores sólo después de que la API esté implementada. Los consumidores prueban la API y dan su opinión sobre ella a los proveedores. A continuación, los proveedores deben revisar la API para incorporar los comentarios recibidos de sus consumidores. Puede optimizar este proceso adaptando el diseño API First.

Con el enfoque API First, los consumidores no tienen que esperar a que el proveedor implemente la API, sino que pueden proceder al desarrollo de su aplicación utilizando la API expuesta. El estado de implementación de la API no afecta a los consumidores, ya que reciben las respuestas designadas para sus solicitudes a través de la API simulada. Así, el desarrollo de la API y el de la aplicación pueden tener lugar al mismo tiempo.

Después de que el proveedor implemente la API, el punto final se actualiza para desviar las invocaciones a la implementación real en lugar de a la respuesta simulada. El proveedor puede entonces desactivar el mocking.

El siguiente diagrama explica el flujo de desarrollo de la API según el diseño API First.

Según el diseño de API First, los proveedores exponen su API a los consumidores cuando el desarrollo está en marcha.