Numa ramificação de sprint recém-criada, não existe conteúdo por predefinição. Esta abordagem ajuda os programadores a concentrarem-se nas alterações necessárias para o sprint atual. Pode adicionar recursos e efetuar modificações utilizando dois métodos principais.Escolher a Sua Abordagem#
| Método | Mais Adequado Para | Principal Benefício |
|---|
| Alterações Manuais | Desenvolvimento API-First | Especificação clara antes do desenvolvimento |
| Importação de OAS | Desenvolvimento Code-First | Comparação automática com a ramificação principal |
A Apidog recomenda vivamente a abordagem API-First (alterações manuais) para maior eficiência e menores custos de colaboração.
Alterações Manuais#
Modificar manualmente o conteúdo dentro de uma ramificação de sprint permite-lhe definir claramente as suas especificações de API antes de avançar para o desenvolvimento.Bifurcar Recursos a partir da Ramificação Principal#
Quando precisa de modificar endpoints, esquemas ou componentes de resposta existentes com base nos requisitos do sprint atual:1.
Utilize Fork from main para criar uma cópia dos recursos necessários
2.
Todas as pastas principais são importadas automaticamente
3.
Os recursos importados são assinalados com indicadores de associação
Obter as Alterações Mais Recentes da Ramificação Principal#
Enquanto trabalha numa ramificação de sprint, atualizações urgentes podem exigir alterações diretamente na ramificação principal. Para sincronizar:1.
Receberá uma notificação quando os recursos associados na ramificação principal forem atualizados
2.
Clique na notificação para rever as alterações
3.
Escolha se pretende obter as atualizações ou manter o conteúdo atual da ramificação de sprint
4.
Selecione o conteúdo pretendido e confirme a atualização
Criar Novos Recursos#
Para criar novos endpoints, esquemas ou componentes de resposta para o sprint atual:1.
Utilize a funcionalidade New para adicionar recursos à ramificação de sprint atual
2.
Se a pasta principal necessária não existir, utilize:Select Endpoint Folders: Escolha pastas existentes
New Endpoint Folder: Crie novas pastas
Reordenar e Ajustar o Conteúdo das Pastas#
Pode realizar as mesmas operações em recursos importados ou recém-criados que realiza na ramificação principal:Pastas importadas com indicadores:Ajustar conteúdo de pastas:Eliminar e Restaurar Recursos#
As ramificações de sprint têm uma funcionalidade de lixo que funciona da mesma forma que a ramificação principal:1.
Elimine recursos conforme necessário
2.
Veja os recursos eliminados em Trash
3.
Restaure recursos quando necessário
Importar, eliminar e restaurar repetidamente o mesmo recurso da ramificação principal pode originar problemas de dados inesperados. Minimize estas operações para manter a integridade dos dados.
Mocking, Comparação e Colaboração#
Endereços de mock únicos:Os endpoints numa ramificação de sprint têm endereços de mock únicos específicos dessa ramificação, dependendo inteiramente das definições de endpoint da ramificação de sprint atual.Comparação com a ramificação principal:Compare recursos da ramificação de sprint com os seus correspondentes na ramificação principal para identificar diferenças específicas.Partilhe endpoints da ramificação de sprint através de ligações de colaboração com outros membros do projeto.Ao clicar numa ligação de colaboração de endpoint de uma ramificação de sprint enquanto estiver noutra ramificação, o sistema irá solicitar-lhe que mude de ramificação. Guarde quaisquer alterações na sua ramificação atual antes de mudar.
Importação de OAS#
Importe ficheiros OpenAPI Specification (OAS) diretamente para uma ramificação de sprint utilizando métodos de importação manual, agendada ou por API.Importar OAS para a Ramificação de Sprint#
1.
Certifique-se de que a ramificação de destino está selecionada no canto superior esquerdo
2.
Navegue até Project Settings → Import Data
3.
Importe dados para a ramificação atual
1.
Compare o "Path & Method" de cada endpoint no ficheiro OAS com a ramificação principal
2.
Se for idêntico: o endpoint não será importado
3.
Se for diferente: o endpoint é associado à ramificação principal e importado
4.
Se for novo: é criado um novo endpoint na ramificação de sprint
1.
Compare os nomes dos esquemas no ficheiro OAS com a ramificação principal
2.
Se for idêntico: o esquema não será importado
3.
Se for diferente: o esquema é associado à ramificação principal e importado
4.
Se for novo: é criado um novo esquema na ramificação de sprint
Os recursos que permanecem completamente inalterados em comparação com a ramificação principal não serão incluídos na ramificação de sprint após a importação, ajudando os programadores a concentrarem-se nas alterações necessárias.
