Flujo de trabajo de colaboración

Esta guía describe el flujo de trabajo recomendado para la colaboración en API en Apidog, desde el diseño inicial hasta la implementación.

Descripción general del flujo de trabajo

El siguiente flujo de trabajo garantiza una colaboración fluida entre diseñadores de API, desarrolladores e ingenieros de QA:

1. Redactar la documentación de la API

Los diseñadores de API crean la documentación inicial de la API en Apidog, definiendo endpoints, parámetros, esquemas y respuestas esperadas.

2. Revisión colaborativa

Los desarrolladores de front-end y back-end trabajan juntos para revisar y mejorar la documentación, garantizando la alineación en:

Casos de uso y requisitos de la API

Estructuras de petición/respuesta

Modelos de datos y esquemas

Manejo de errores

3. Inicio del desarrollo con datos mock

Los desarrolladores de front-end pueden comenzar el desarrollo de inmediato utilizando datos mock generados automáticamente en función de la documentación de la API en Apidog.

Beneficios:

No se requiere la creación manual de reglas mock

Desarrollo en paralelo sin esperar a que se complete el backend

Estructuras de datos realistas para pruebas

4. Depuración con casos de uso de API

Los desarrolladores de back-end depuran las API durante el desarrollo utilizando casos de uso predefinidos.

Criterios de finalización:

Todos los casos de uso superan la depuración correctamente

Cualquier cambio realizado durante el desarrollo actualiza automáticamente la especificación de la API

Garantiza un mantenimiento de la API oportuno y rentable

5. Guardar casos de endpoint

Una vez completada la depuración, los desarrolladores de back-end guardan las peticiones correctas como casos de endpoint para:

Pruebas futuras

Documentación de ejemplos funcionales

Referencia de QA

6. Pruebas de API

Los ingenieros de QA prueban las API directamente utilizando casos de endpoint predefinidos, garantizando:

Corrección funcional

Formatos de respuesta esperados

Manejo de errores

Casos límite

7. Pruebas de integración

Después de desarrollar todas las API, los ingenieros de QA (o los desarrolladores de back-end) utilizan la función de colección de prueba para realizar pruebas de integración completas de múltiples API.

Propósito:

Verificar el funcionamiento fluido del proceso de llamada a la API

Probar flujos de trabajo de extremo a extremo

Validar el flujo de datos entre endpoints

8. Depuración conjunta

Cuando el desarrollo de front-end y back-end haya finalizado:

Los desarrolladores de front-end cambian de datos mock a datos reales

Ambos equipos verifican que la integración funcione según lo esperado

Siga meticulosamente las especificaciones de la API para garantizar la compatibilidad

Beneficios de este flujo de trabajo

Beneficio	Descripción
Desarrollo en paralelo	Los equipos de front-end y back-end trabajan simultáneamente
Reducción de errores	El desarrollo basado en especificaciones minimiza la falta de comunicación
Iteración más rápida	Los datos mock automáticos y las actualizaciones de especificaciones aceleran el desarrollo
Mejores pruebas	Los casos predefinidos y las pruebas de integración garantizan la calidad
Documentación clara	La documentación viva se mantiene sincronizada con la implementación

Flujo de trabajo de colaboración

Descripción general del flujo de trabajo#

1. Redactar la documentación de la API#

2. Revisión colaborativa#

3. Inicio del desarrollo con datos mock#

4. Depuración con casos de uso de API#

5. Guardar casos de endpoint#

6. Pruebas de API#

7. Pruebas de integración#

8. Depuración conjunta#

Beneficios de este flujo de trabajo#