Visão geral

Este guia ajudará você a começar rapidamente, desde a configuração da sua conta até a realização das suas primeiras requisições de API.

Guia em vídeo

Confira a playlist completa Getting Started with Apidog no YouTube.

Pré-requisitos

Antes de começar, certifique-se de que você tenha:

Configuração da conta: Cadastre-se para obter uma conta gratuita do Apidog em app.apidog.com, caso ainda não tenha feito isso.

Entrar: Faça login na aplicação web do Apidog ou na aplicação cliente (baixe aqui).

Abrir um projeto: Inicie um novo projeto ou importe um projeto existente para organizar suas APIs. Saiba mais sobre projetos e conceitos básicos ou sobre o guia da interface do Apidog.

O projeto Pet Store

O projeto Pet Store é um exemplo integrado do Apidog que ajuda você a aprender os principais conceitos e recursos. Comece clicando em Create Sample Project na página de boas-vindas do Apidog.

Escolha seu modelo de desenvolvimento

O Apidog oferece suporte a duas abordagens principais de desenvolvimento de API:

Modelo	Descrição	Mais indicado para	Fluxo de trabalho
Design-first	Defina as especificações da API antes da implementação	Equipes que priorizam planejamento e documentação	Especificação → Requisição → Teste → Compartilhamento
Request-first	Crie e teste APIs a partir de requisições reais	Equipes ágeis, prototipagem, APIs não documentadas	Requisição → Especificação → Teste → Compartilhamento

Ambos os modelos são totalmente compatíveis e podem ser alternados a qualquer momento. Escolha com base nas preferências de fluxo de trabalho da sua equipe. Saiba mais sobre o Modo Design-first e o Modo Request-first.

Modelo Design-first

Na abordagem Design-first, você define as especificações da sua API antecipadamente, garantindo clareza e consistência antes da implementação. Esse método é ideal para equipes que priorizam o planejamento e desejam criar uma documentação abrangente desde o início.

Especifique um novo endpoint
Defina o endpoint da sua API com caminho, método, parâmetros e respostas. Isso cria a base da especificação da sua API.

Alterne para o modo Design-first
No canto inferior esquerdo da interface do Apidog, selecione o modo "Design-first" para continuar projetando seu endpoint.

Faça uma requisição para o endpoint
Teste o endpoint definido enviando requisições reais para validar o design.

Adicione uma assertiva
Configure verificações automatizadas para garantir que as respostas da sua API atendam aos critérios esperados.

Crie um cenário de teste
Crie suítes de teste abrangentes que cubram vários endpoints e casos de uso.

Compartilhe sua documentação de API
Publique e compartilhe sua documentação de API com as partes interessadas para feedback e integração.

Explore recursos avançados
Aprofunde-se nos recursos do Apidog, como ambientes, esquemas e ferramentas de colaboração.

Comece com Design-first

Especifique seu primeiro endpoint

Modelo Request-first

A abordagem Request-first começa com chamadas reais de API, permitindo que você prototipe e valide APIs rapidamente. Esse método é perfeito para equipes que trabalham com backends existentes, APIs de terceiros ou quando você precisa documentar endpoints não documentados.

Envie uma requisição
Faça uma chamada de API para testar ou explorar um endpoint existente.

Alterne para o modo Request-first
No canto inferior esquerdo da interface do Apidog, selecione o modo "Request-first".

Adicione uma assertiva
Implemente regras de validação automatizadas para garantir a confiabilidade e a correção da API.

Crie um cenário de teste
Desenvolva suítes de teste abrangentes que simulem interações reais com a API.

Compartilhe sua documentação de API
Gere e distribua documentação de API profissional para sua equipe e seus parceiros.

Explore recursos avançados
Descubra toda a gama de ferramentas de teste, colaboração e automação do Apidog.

Comece com Request-first

Envie sua primeira requisição

Alternar entre modos

Você pode alternar entre os modos Design-first e Request-first a qualquer momento usando o seletor no canto inferior esquerdo da interface:

Essa flexibilidade permite que você adapte seu fluxo de trabalho à medida que seu projeto evolui.

Guia em vídeo#

Pré-requisitos#

Escolha seu modelo de desenvolvimento#

Modelo Design-first#

Modelo Request-first#

Alternar entre modos#

Guia em vídeo

Pré-requisitos

Escolha seu modelo de desenvolvimento

Modelo Design-first

Modelo Request-first

Alternar entre modos