Fluxo de Trabalho de Colaboração

Este guia descreve o fluxo de trabalho recomendado para colaboração em APIs no Apidog, desde o design inicial até a implantação.

Visão Geral do Fluxo de Trabalho

O fluxo de trabalho a seguir garante uma colaboração eficiente entre designers de API, desenvolvedores e engenheiros de QA:

1. Elaborar a Documentação da API

Designers de API criam a documentação inicial da API no Apidog, definindo endpoints, parâmetros, esquemas e respostas esperadas.

2. Revisão Colaborativa

Desenvolvedores de front-end e back-end trabalham em conjunto para revisar e aprimorar a documentação, garantindo alinhamento em relação a:

Casos de uso e requisitos da API

Estruturas de requisição/resposta

Modelos de dados e esquemas

Tratamento de erros

3. Início do Desenvolvimento com Dados de Mock

Desenvolvedores de front-end podem iniciar o desenvolvimento imediatamente usando dados de mock gerados automaticamente com base na documentação da API no Apidog.

Benefícios:

Não é necessário criar regras de mock manualmente

Desenvolvimento paralelo sem aguardar a conclusão do backend

Estruturas de dados realistas para testes

4. Depuração com Casos de Uso da API

Desenvolvedores de back-end depuram APIs durante o desenvolvimento usando casos de uso predefinidos.

Critérios de conclusão:

Todos os casos de uso passam pela depuração com sucesso

Quaisquer alterações feitas durante o desenvolvimento atualizam automaticamente a especificação da API

Garante a manutenção da API de forma oportuna e econômica

5. Salvar Casos de Endpoint

Quando a depuração estiver concluída, desenvolvedores de back-end salvam requisições bem-sucedidas como casos de endpoint para:

Testes futuros

Documentação de exemplos funcionais

Referência para QA

6. Testes de API

Engenheiros de QA testam APIs diretamente usando casos de endpoint predefinidos, garantindo:

Correção funcional

Formatos de resposta esperados

Tratamento de erros

Casos extremos

7. Testes de Integração

Depois que todas as APIs forem desenvolvidas, engenheiros de QA (ou desenvolvedores de back-end) utilizam o recurso de coleção de testes para realizar testes de integração abrangentes com múltiplas APIs.

Objetivo:

Verificar o funcionamento adequado do processo de chamada da API

Testar fluxos de trabalho de ponta a ponta

Validar o fluxo de dados entre endpoints

8. Depuração Conjunta

Quando o desenvolvimento de front-end e back-end estiver concluído:

Desenvolvedores de front-end alternam de dados de mock para dados reais

Ambas as equipes verificam se a integração funciona conforme esperado

Siga rigorosamente as especificações da API para garantir compatibilidade

Benefícios Deste Fluxo de Trabalho

Benefício	Descrição
Desenvolvimento Paralelo	As equipes de front-end e back-end trabalham simultaneamente
Redução de Erros	O desenvolvimento orientado por especificação minimiza falhas de comunicação
Iteração Mais Rápida	Dados de mock automáticos e atualizações de especificação aceleram o desenvolvimento
Melhores Testes	Casos predefinidos e testes de integração garantem qualidade
Documentação Clara	A documentação viva permanece sincronizada com a implementação

Fluxo de Trabalho de Colaboração

Visão Geral do Fluxo de Trabalho#

1. Elaborar a Documentação da API#

2. Revisão Colaborativa#

3. Início do Desenvolvimento com Dados de Mock#

4. Depuração com Casos de Uso da API#

5. Salvar Casos de Endpoint#

6. Testes de API#

7. Testes de Integração#

8. Depuração Conjunta#

Benefícios Deste Fluxo de Trabalho#