(The Minspait Crowd) Soporte Open API 3 en API Manager de Plataforma

Open API 3

El equipo «The Minspait Crowd», compuesto por Francisco Javier, Erika y Giusseppe y mentorizados por Javier asumió el reto de implementar el soporte del estándar Open API 3 en el API Manager de Onesait Platform.

El Reto

El reto consistía en soportar el estándar OpenAPI3 en plataforma, lo que implicaba los siguientes requisitos:

  • Soportar la publicación de APIs externas a partir de documentación Swagger Open API 3 para permitir la integración de servicios de terceros.
  • Generación de documentación Swagger Open API 3 para el resto de APIs: APIs internas de plataforma.
  • Mantener retrocompatibilidad con APIs con documentación Swagger 2, es decir, seguir dando soporte a APIs que sigan el estándar Swagger 2.0.

Las principales diferencias entre ambos estándares se pueden observar en el siguiente stack comparativo.

A continuación mostramos un ejemplo de la misma API en formato Swagger 2.0 frente al formato Open API 3.0:

Pet Store Swagger 2.0

Pet Store Open API 3.0

Componentes modificados

A nivel de módulo, el equipo que desarrollar sobre el API Manager de plataforma, adaptando el código para cumplir con los requisitos del reto.

Repositorio de Github

El equipo estuvo trabajando sobre un repositorio público que contenía el código de la versión Community de la Plataforma: https://github.com/onesaitplatform/onesaitplatform-revolution-the-minspait-crowd

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *