Proceso de industrialización SOA

¿Qué es industrialización SOA? arrow2-down

Consiste en la automatización de la generación de contratos a partir de un nuevo formato de descripción de operaciones (DO) y la ejecución de un pipeline. Este procedimiento es aplicable tanto a la creación de un nuevo producto API, una API o una operación, así como a su modificación.

Verifique la guía rápida para analistas SOA : Guía rápida proceso de industrialización APIS.

¿Qué .feature debo compartirle al desarrolladores? arrow2-down

Al equipo de desarrollo, se sugiere compartirles la rama donde ejecutamos la generación del pipeline para que tomen lo que puedan necesitar. Ejemplo, los .feature que se llaman "contractTest" es lo que aprovechan los desarrolladores para agilizar las pruebas.

Sin embargo, ten presente que en el repo "Template_ServiciosIntegracionAPIs_Documentacion" los insumos que se suben son el contrato de la(s) API y las acceptanceTest.feature.

Error MUST SET FRAME en la ejecución del pipeline arrow2-down

Revisa que no le hayas cambiado el formato al archivo, específicamente que las celdas del DO estén con todos los bordes.

Error The filed: [fieldName] in the minimum length o maximum length arrow2-down

Cuando este mensaje está asociado a la longitud máxima o mínima de un campo, significa que hay un campo en el DO que tiene filas compartidas, por allí debes buscar la corrección.

Error en pipeline Cannot resolve reference: #/... arrow2-down

Este error se muestra en el stage de API Contract relacionado con esta descripción "409nombreFuncionalOperación", soluciónalo borrando los caracteres como espacios, tabs o saltos de línea al inicio o final del nombre funcional en la portada del DO.

¿Debo subir al repositorio de documentación de APIs (Template), los insumos del repositorio del NU/AW? arrow2-down

Si, es necesario montar el contrato beta generado y los escenarios .feature.

¿Debo llevar las documentación antigua de las APIs a la nueva versión del DO? arrow2-down

Normalmente se presentan dos casos en esta situación:

  • Que requieras agregar una nueva API a un producto con APIs que tengan documentación antigua.
    Si no había superado fase de pruebas van a necesitar el insumo de los escenarios .feature con marcación Karate; es decir, que deberás volcar el contenido de los DO existentes en el nuevo formato.
  • Que debas versionar una API porque van a agregar nuevos campos.
    Para este caso debes pasar al nuevo formato del DO la información correspondiente a la(s) operación(es).
¿Qué debo tener presente cuando tengo varias operaciones que tienen objetos con nombres iguales? arrow2-down

  1. Verifica que tus objetos y los elementos que contenga sean exactamente iguales en cuanto a "nombre", "descripción", "clasificación de información", "tipo de parámetro" y ejemplo".

  2. Si los objetos que se han nombrado igual contienen elementos diferentes, hace que justamente no estemos hablando de la misma vista de esas entidades y te va ha arrojar error. Expresa funcionalmente esa diferencia cambiando el nombre de uno de los objetos o elementos, para aportar a la claridad en su alcance.