Visão geral
Guia em vídeo
Pré-requisitos
1.
2.
3.
O projeto Pet Store
Escolha o seu modelo de desenvolvimento
| Modelo | Descrição | Mais indicado para | Fluxo de trabalho |
|---|---|---|---|
| Design-first | Definir especificações de API antes da implementação | Equipas que dão prioridade ao planeamento e à documentação | Especificação → Pedido → Teste → Partilhar |
| Request-first | Criar e testar APIs a partir de pedidos reais | Equipas ágeis, prototipagem, APIs sem documentação | Pedido → Especificação → Teste → Partilhar |
Modelo Design-first
Especificar um novo endpoint
Defina o endpoint da sua API com caminho, método, parâmetros e respostas. Isto cria a base da especificação da sua API.
Defina o endpoint da sua API com caminho, método, parâmetros e respostas. Isto cria a base da especificação da sua API.
Mudar para o modo Design-first
No canto inferior esquerdo da interface do Apidog, selecione o modo "Design-first" para continuar a conceber o seu endpoint.
No canto inferior esquerdo da interface do Apidog, selecione o modo "Design-first" para continuar a conceber o seu endpoint.
Fazer um pedido ao endpoint
Teste o endpoint definido enviando pedidos reais para validar o design.
Teste o endpoint definido enviando pedidos reais para validar o design.
Adicionar uma asserção
Configure verificações automatizadas para garantir que as respostas da sua API cumprem os critérios esperados.
Configure verificações automatizadas para garantir que as respostas da sua API cumprem os critérios esperados.
Criar um cenário de teste
Crie conjuntos de testes abrangentes que cubram vários endpoints e casos de utilização.
Crie conjuntos de testes abrangentes que cubram vários endpoints e casos de utilização.
Partilhar a documentação da sua API
Publique e partilhe a sua documentação de API com as partes interessadas para obter feedback e facilitar a integração.
Publique e partilhe a sua documentação de API com as partes interessadas para obter feedback e facilitar a integração.
Explorar funcionalidades avançadas
Explore mais aprofundadamente as capacidades do Apidog, como ambientes, esquemas e ferramentas de colaboração.
Explore mais aprofundadamente as capacidades do Apidog, como ambientes, esquemas e ferramentas de colaboração.
Modelo Request-first
Enviar um pedido
Faça uma chamada de API para testar ou explorar um endpoint existente.
Faça uma chamada de API para testar ou explorar um endpoint existente.
Mudar para o modo Request-first
No canto inferior esquerdo da interface do Apidog, selecione o modo "Request-first".
No canto inferior esquerdo da interface do Apidog, selecione o modo "Request-first".
Adicionar uma asserção
Implemente regras de validação automatizadas para garantir a fiabilidade e a correção da API.
Implemente regras de validação automatizadas para garantir a fiabilidade e a correção da API.
Criar um cenário de teste
Desenvolva conjuntos de testes abrangentes que simulem interações reais com a API.
Desenvolva conjuntos de testes abrangentes que simulem interações reais com a API.
Partilhar a documentação da sua API
Gere e distribua documentação de API profissional para a sua equipa e parceiros.
Gere e distribua documentação de API profissional para a sua equipa e parceiros.
Explorar funcionalidades avançadas
Descubra toda a gama de ferramentas de teste, colaboração e automatização do Apidog.
Descubra toda a gama de ferramentas de teste, colaboração e automatização do Apidog.
Alternar entre modos
Modified at 2026-06-09 08:54:45