Por cada operación debes considerar desde lo funcional unos escenarios y cual sería su comportamiento esperado. La idea es que se identifiquen los escenarios funcionales más relevantes o que generen variaciones en las estructuras de la petición (request) y/o respuesta (response).
En Apicurio Studio en cada operación se debe documentar cada escenario, aprovechando la funcionalidad para agregar ejemplos y su generación de mensajería JSON basada en los esquemas definidos. Garantizando correspondencia entre request y response y, asegurando que se tiene la etiqueta "description" al menos a nivel de request donde deberá ir el texto en formato Gherkin (ESCENARIO DADO CUANDO ENTONCES).
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.