BlueOasis

¿Cómo se garantiza la integridad y calidad del blueprint productor? arrow2-down

Se establecen requisitos específicos para el contenido y formato del blueprint, asegurando que contenga la información necesaria y esté estructurado de manera coherente para una generación precisa del contrato de API.

Ten presente los lineamientos para su construcción de la Guía para realizar Modelamiento SOA.

¿Qué requisitos debe cumplir el blueprint productor para generar el contrato de API? arrow2-down

El blueprint debe incluir cuatro hojas específicas con nombres definidos: "Guía", "Escenarios BDD", "NombreBlueprint" y "Mapa de contexto". Además, las pestañas deben tener nombres coincidentes con las operaciones y seguir un formato específico para los nombres de API, productos y operaciones. El blueprint debe garantizar la estructura en el nombre del producto: Producto - NombreApi v1.0.0.

 

Por último, ten presente la Guía para realizar Modelamiento SOA.

¿Puedo entregar el contrato generado a partir del blueprint? arrow2-down

No, se debe importar en Apicurio Studio para continuar con el diseño de la API y garantizar que el contrato cumpla con todos los estándares requeridos, además de realizar ajustes necesarios como eliminar operaciones de seguridad no aplicables.

¿Qué debo tener para correr el pipeline para generar el contrato? arrow2-down

Debes contar con: Las credenciales de Lucidchart que dan acceso al blueprint productor, el identificador del blueprint el cual se encuentra en la URL del blueprint en Lucidchart, el código de verificación es necesario para autorizar el acceso a Lucidchart. 

 

Te invitamos consultar y seguir la guía ¿Cómo generar el contrato OpenAPI desde un blueprint? para obtener estos insumos para la ejecución del pipeline.

¿Qué es un pipeline y por qué se utiliza para ejecutar la aplicación de generación de contratos? arrow2-down

Un pipeline es una serie de pasos automatizados que permiten ejecutar tareas de manera secuencial, garantizando la consistencia y eficiencia en la ejecución, en este caso, en la aplicación de generación de contratos; adicionalmente, asegura que se sigan los mismos pasos en cada ejecución.

 

Este pipeline se ejecuta desde el repositorio correspondiente, ver la guía ¿Cómo generar el contrato OpenAPI desde un blueprint?

¿Qué hacer en caso de que el pipeline falle durante la ejecución? arrow2-down

Si el pipeline falla se mostrarán los errores correspondientes. Se debe revisar la información proporcionada y corregir cualquier problema identificado antes de volver a ejecutarlo.

¿Dónde obtengo ayuda con la generación del contratos de API desde el blueprint? arrow2-down

Te invitamos que sigas la guía de ¿Cómo generar el contrato OpenAPI desde un blueprint?,  adicionalmente puedes consultar la documentación de las nuevas herramientas para el análisis y diseño de APIs, el sitio de formación SOA, el foro de discusión de nuestra comunidad o puedes escribirnos a través del chat o formulario de contacto, para que nuestro equipo te ayude con temas específicos durante el proceso de generación de tu contrato.

¿Qué es blueprint productor y cómo se conversa con el contrato OpenAPI? arrow2-down

Un blueprint productor es un documento que permite mapear las capacidades de negocio que se van a construir o modificar para que otros lo consuman; allí, se modelan los procesos de negocio y sus interacciones con las APIs. Este blueprint se construye en el aplicativo Lucidchart, aplicativo que nos brinda una función para extraer la data y generar el contrato de API bajo el estándar OpenAPI 3.0.