Em uma branch de sprint recém-criada, não há conteúdo por padrão. Essa abordagem ajuda os desenvolvedores a se concentrarem nas alterações necessárias para a sprint atual. Você pode adicionar recursos e fazer modificações usando dois métodos principais.Escolhendo sua abordagem#
| Método | Melhor 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 branch principal |
A Apidog recomenda fortemente a abordagem API-First (alterações manuais) para aumentar a eficiência e reduzir os custos de colaboração.
Alterações manuais#
Modificar manualmente o conteúdo dentro de uma branch de sprint permite que você defina claramente as especificações da sua API antes de iniciar o desenvolvimento.Bifurcando recursos da branch principal#
Quando você precisa modificar endpoints, schemas ou componentes de resposta existentes com base nos requisitos da sprint atual:1.
Use Fork from main para criar uma cópia dos recursos necessários
2.
Todas as pastas pai são importadas automaticamente
3.
Os recursos importados são marcados com indicadores de associação
Obtendo as alterações mais recentes da branch principal#
Ao trabalhar em uma branch de sprint, atualizações urgentes podem exigir alterações diretamente na branch principal. Para sincronizar:1.
Você receberá uma notificação quando os recursos associados na branch principal forem atualizados
2.
Clique na notificação para revisar as alterações
3.
Escolha se deseja obter as atualizações ou manter o conteúdo atual da branch de sprint
4.
Selecione o conteúdo desejado e confirme a atualização
Criando novos recursos#
Para criar novos endpoints, schemas ou componentes de resposta para a sprint atual:1.
Use o recurso New para adicionar recursos à branch de sprint atual
2.
Se a pasta pai necessária não existir, use:Select Endpoint Folders: escolha pastas existentes
New Endpoint Folder: crie novas pastas
Reordenando e ajustando o conteúdo das pastas#
Você pode realizar as mesmas operações em recursos importados ou recém-criados que realizaria na branch principal:Pastas importadas com indicadores:Ajustar o conteúdo das pastas:Excluindo e restaurando recursos#
As branches de sprint têm um recurso de lixeira que funciona da mesma forma que na branch principal:1.
Exclua recursos conforme necessário
2.
Visualize os recursos excluídos em Trash
3.
Restaure recursos quando necessário
Importar, excluir e restaurar repetidamente o mesmo recurso da branch principal pode levar a problemas de dados inesperados. Minimize essas operações para manter a integridade dos dados.
Criando mocks, comparando e colaborando#
Endereços de mock exclusivos:Endpoints em uma branch de sprint têm endereços de mock exclusivos específicos dessa branch, dependendo totalmente das definições de endpoint da branch de sprint atual.Comparando com a branch principal:Compare os recursos da branch de sprint com seus equivalentes da branch principal para identificar diferenças específicas.Compartilhe endpoints da branch de sprint por meio de links de colaboração com outros membros do projeto.Ao clicar em um link de colaboração de endpoint da branch de sprint enquanto estiver em outra branch, o sistema solicitará que você alterne de branch. Salve todas as alterações na sua branch atual antes de alternar.
Importação de OAS#
Importe arquivos OpenAPI Specification (OAS) diretamente para uma branch de sprint usando métodos de importação manual, agendada ou por API.Importando OAS para a branch de sprint#
1.
Certifique-se de que a branch de destino esteja selecionada no canto superior esquerdo
2.
Navegue até Project Settings → Import Data
3.
Importe os dados para a branch atual
1.
Compare o "Path & Method" de cada endpoint no arquivo OAS com a branch principal
2.
Se for idêntico: o endpoint não será importado
3.
Se for diferente: o endpoint será associado à branch principal e importado
4.
Se for novo: um novo endpoint será criado na branch de sprint
1.
Compare os nomes dos schemas no arquivo OAS com a branch principal
2.
Se for idêntico: o schema não será importado
3.
Se for diferente: o schema será associado à branch principal e importado
4.
Se for novo: um novo schema será criado na branch de sprint
Recursos que permanecerem completamente inalterados em comparação com a branch principal não serão incluídos na branch de sprint após a importação, ajudando os desenvolvedores a se concentrarem nas alterações necessárias.
