WSDL y servicios SOAP como diagrama de flujo

Qué es un archivo WSDL

WSDL (Web Services Description Language) es un formato XML para describir servicios web, casi siempre servicios SOAP. WSDL 1.1, la versión más frecuente en sistemas existentes, organiza la descripción en:

• types: las estructuras de datos, normalmente en XML Schema,
• messages: los datos que se intercambian,
• portType: el conjunto de operaciones que ofrece el servicio,
• binding: cómo se transportan las operaciones (por ejemplo, SOAP sobre HTTP),
• service: la dirección de red del punto de acceso.

WSDL 2.0 cambia el nombre de algunos conceptos (interface en lugar de portType, endpoint en lugar de port), pero mantiene la misma idea.

Encontrar las operaciones

Las operaciones son la parte útil para un diagrama: nombres como CrearPoliza, ObtenerPresupuesto o CancelarPedido. En WSDL 1.1, busca los elementos operation dentro de portType. Su nombre suele describir una acción de negocio, por eso son buenas etiquetas para los pasos automáticos.

De las operaciones al proceso

Las operaciones son un catálogo, no una secuencia. El orden («obtener un presupuesto y, si el cliente acepta, crear la póliza») sale del proceso de negocio. Como con los archivos OpenAPI, el mejor resultado sale de combinar:

1. una descripción breve del proceso, que nombre al responsable de cada paso,
2. el WSDL, para que los pasos automáticos lleven el nombre exacto de la operación.

Importar un WSDL en Flowchartio

Guarda el WSDL con la extensión .xml (el importador acepta .json, .yaml, .yml y .xml, hasta 5 MB). Flowchartio lee las operaciones y las usa como endpoints durante la generación, así que un paso como «Crear la póliza» puede llevar la etiqueta CrearPoliza.

Qué documentar en una integración SOAP

• Los fallos (SOAP faults) que devuelve cada operación y cómo reacciona tu sistema.
• Tiempos de espera y reintentos, con sus límites, como en cualquier flujo de integración de API.
• Pasos de seguridad, como firmas o cabeceras de autenticación, cuando afecten al flujo.
• Traspasos a personas, por ejemplo una revisión manual cuando el servicio rechaza una petición.

¿Diagrama de flujo o BPMN?

Las organizaciones con servicios SOAP a menudo también tienen modelos BPMN. Si el objetivo es explicar la integración a personas, basta con un diagrama de flujo; si debe ejecutarse en un motor de procesos, consulta diagrama de flujo o BPMN.

Importa tu WSDL y genera el diagrama.