En una rama de sprint recién creada, no hay contenido de forma predeterminada. Este enfoque ayuda a los desarrolladores a centrarse en los cambios necesarios para el sprint actual. Puede añadir recursos y realizar modificaciones mediante dos métodos principales.Elección de su enfoque#
| Método | Ideal para | Beneficio clave |
|---|
| Cambios manuales | Desarrollo API-First | Especificación clara antes del desarrollo |
| Importación de OAS | Desarrollo Code-First | Comparación automática con la rama principal |
Apidog recomienda encarecidamente el enfoque API-First (cambios manuales) para aumentar la eficiencia y reducir los costes de colaboración.
Cambios manuales#
Modificar manualmente el contenido dentro de una rama de sprint le permite definir claramente las especificaciones de su API antes de comenzar el desarrollo.Bifurcar recursos desde la rama principal#
Cuando necesite modificar endpoints, esquemas o componentes de respuesta existentes según los requisitos del sprint actual:1.
Use Fork from main para crear una copia de los recursos necesarios
2.
Todas las carpetas principales se importan automáticamente
3.
Los recursos importados se marcan con indicadores de asociación
Obtener los cambios más recientes desde la rama principal#
Mientras trabaja en una rama de sprint, las actualizaciones urgentes pueden requerir cambios directamente en la rama principal. Para sincronizar:1.
Recibirá una notificación cuando se actualicen los recursos asociados en la rama principal
2.
Haga clic en la notificación para revisar los cambios
3.
Elija si desea obtener las actualizaciones o conservar el contenido actual de la rama de sprint
4.
Seleccione el contenido deseado y confirme la actualización
Crear nuevos recursos#
Para crear nuevos endpoints, esquemas o componentes de respuesta para el sprint actual:1.
Use la función New para añadir recursos a la rama de sprint actual
2.
Si la carpeta principal requerida no existe, use:Select Endpoint Folders: Elegir carpetas existentes
New Endpoint Folder: Crear nuevas carpetas
Reordenar y ajustar el contenido de las carpetas#
Puede realizar las mismas operaciones en los recursos importados o recién creados que en la rama principal:Arrastrar para reordenar:Carpetas importadas con indicadores:Ajustar el contenido de las carpetas:Eliminar y restaurar recursos#
Las ramas de sprint tienen una función de papelera que funciona igual que en la rama principal:1.
Elimine recursos según sea necesario
2.
Vea los recursos eliminados en Trash
3.
Restaure recursos cuando sea necesario
Importar, eliminar y restaurar repetidamente el mismo recurso de la rama principal puede provocar problemas de datos inesperados. Minimice estas operaciones para mantener la integridad de los datos.
Mock, comparación y colaboración#
Los endpoints en una rama de sprint tienen direcciones mock únicas específicas para esa rama, que dependen completamente de las definiciones de endpoints de la rama de sprint actual.Comparación con la rama principal:Compare los recursos de la rama de sprint con sus equivalentes de la rama principal para identificar diferencias específicas.Comparta endpoints de la rama de sprint mediante enlaces de colaboración con otros miembros del proyecto.Al hacer clic en un enlace de colaboración de endpoint de una rama de sprint mientras se encuentra en otra rama, el sistema le solicitará cambiar de rama. Guarde cualquier cambio en su rama actual antes de cambiar.
Importación de OAS#
Importe archivos de OpenAPI Specification (OAS) directamente en una rama de sprint mediante métodos de importación manual, programada o por API.Importar OAS en la rama de sprint#
1.
Asegúrese de que la rama de destino esté seleccionada en la esquina superior izquierda
2.
Vaya a Project Settings → Import Data
3.
Importe los datos en la rama actual
Comparación automática con la rama principal#
Al importar OAS en la rama de sprint, la lógica de procesamiento es la siguiente:1.
Comparar el "Path & Method" de cada endpoint en el archivo OAS con la rama principal
2.
Si es idéntico: el endpoint no se importará
3.
Si es diferente: el endpoint se asocia con la rama principal y se importa
4.
Si es nuevo: se crea un nuevo endpoint en la rama de sprint
1.
Comparar los nombres de los esquemas en el archivo OAS con la rama principal
2.
Si es idéntico: el esquema no se importará
3.
Si es diferente: el esquema se asocia con la rama principal y se importa
4.
Si es nuevo: se crea un nuevo esquema en la rama de sprint
Los recursos que no hayan cambiado en absoluto en comparación con la rama principal no se incluirán en la rama de sprint después de la importación, lo que ayuda a los desarrolladores a centrarse en los cambios necesarios.
