Fluxo de trabalho de colaboração

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

Visão geral do fluxo de trabalho

O fluxo de trabalho seguinte assegura uma colaboração fluida entre designers de API, programadores e engenheiros de QA:

1. Criar o rascunho da documentação da API

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

2. Revisão colaborativa

Os programadores de front-end e back-end trabalham em conjunto para rever e melhorar a documentação, assegurando o alinhamento em relação a:

Casos de utilização da API e requisitos

Estruturas de pedido/resposta

Modelos de dados e esquemas

Tratamento de erros

3. Início do desenvolvimento com dados mock

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

Benefícios:

Não é necessária a criação manual de regras de mock

Desenvolvimento paralelo sem esperar pela conclusão do backend

Estruturas de dados realistas para testes

4. Depuração com casos de utilização da API

Os programadores de back-end depuram APIs durante o desenvolvimento utilizando casos de utilização predefinidos.

Critérios de conclusão:

Todos os casos de utilização passam na depuração com sucesso

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

Garante uma manutenção da API atempada e económica

5. Guardar casos de endpoint

Quando a depuração estiver concluída, os programadores de back-end guardam os pedidos bem-sucedidos como casos de endpoint para:

Testes futuros

Documentação de exemplos funcionais

Referência para QA

6. Teste de APIs

Os engenheiros de QA testam APIs diretamente utilizando casos de endpoint predefinidos, assegurando:

Correção funcional

Formatos de resposta esperados

Tratamento de erros

Casos extremos

7. Testes de integração

Depois de todas as APIs serem desenvolvidas, os engenheiros de QA (ou programadores de back-end) utilizam a funcionalidade de coleção de testes para realizar testes de integração abrangentes com múltiplas APIs.

Objetivo:

Verificar o funcionamento fluido 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:

Os programadores de front-end mudam de dados mock para dados reais

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

Siga meticulosamente as especificações da API para assegurar a compatibilidade

Benefícios deste fluxo de trabalho

Benefício	Descrição
Desenvolvimento paralelo	As equipas de front-end e back-end trabalham simultaneamente
Redução de erros	O desenvolvimento orientado por especificações minimiza falhas de comunicação
Iteração mais rápida	Os dados mock automáticos e as atualizações de especificação aceleram o desenvolvimento
Melhores testes	Casos predefinidos e testes de integração asseguram a qualidade
Documentação clara	A documentação viva mantém-se sincronizada com a implementação

Fluxo de trabalho de colaboração

Visão geral do fluxo de trabalho#

1. Criar o rascunho da documentação da API#

2. Revisão colaborativa#

3. Início do desenvolvimento com dados mock#

4. Depuração com casos de utilização da API#

5. Guardar casos de endpoint#

6. Teste de APIs#

7. Testes de integração#

8. Depuração conjunta#

Benefícios deste fluxo de trabalho#