A interface principal do Apidog é dividida nestas áreas principais:Cabeçalho: Navegação superior com gerenciamento de projetos e configurações do usuário.
Barra lateral: Painel esquerdo para acessar recursos principais.
Área de trabalho: Área central com árvore de diretórios, abas e seletor de ambiente.
Rodapé: Barra inferior para status, ferramentas e links da comunidade.
Cabeçalho#
O cabeçalho fornece acesso rápido a funções essenciais.| Recurso | Descrição |
|---|
| Início | Acesse sua página inicial pessoal com equipes, projetos e hub de APIs. |
| Abas de projeto | Alterne entre projetos. Clique no botão ao lado do nome para abrir em uma nova janela. |
| Upgrade/Plano | Visualize o plano atual da sua equipe. |
| Atualizar | Recarregue os dados do projeto. Observação: isso fecha todas as abas abertas. |
| Configurações | Configure definições locais, como aparência e proxy. |
| Notificações | Verifique alertas de atividade da equipe. |
| Avatar | Gerencie configurações da conta e tokens de acesso. |
Para alternar entre projetos, clique em qualquer aba de projeto no cabeçalho.
Barra lateral#
A Barra lateral organiza os principais recursos do Apidog.| Recurso | Descrição |
|---|
| Ícone do projeto | Vá para a visão geral de equipes e projetos. |
| APIs | Defina, depure, envie requisições, crie schemas e escreva documentação. |
| Testes | Execute requisições em lote, crie cenários, visualize relatórios e gerencie CI/CD. |
| Compartilhar documentação | Compartilhe e publique a documentação da API com opções de personalização. |
| Histórico | Visualize e reenvie requisições enviadas. |
| Configurações | Gerencie configurações do projeto, notificações e dados. |
| Convidar | Convide usuários para o projeto. |
Use a Barra lateral para acessar rapidamente recursos usados com frequência, como APIs e Testes.
Área de trabalho#
A Área de trabalho é o espaço central para gerenciar elementos do projeto.Árvore de diretórios#
A árvore de diretórios organiza os componentes do projeto de forma hierárquica.| Recurso | Descrição |
|---|
| Branches e versões | Alterne entre branches ou gerencie versões. O padrão é a branch principal. |
| Pesquisa e filtro | Pesquise endpoints (não pastas ou casos). |
| Criar novo | Adicione endpoints, requisições, schemas etc. |
| <Nome do Projeto> | Visualização de alto nível do projeto. |
| Endpoints | Organize endpoints e casos em pastas. |
| Schemas | Gerencie schemas em pastas. |
| Componentes | Componentes de resposta reutilizáveis. |
| API de Admin | Contém ferramentas para o administrador processar dados em lote |
| Requisições rápidas | Organiza requisições rápidas feitas neste projeto |
Para criar um novo endpoint, clique no ícone Criar novo na árvore de diretórios.
Abas#
Clicar em um elemento abre uma aba. As abas oferecem suporte a tipos como Endpoint, Schema, Requisição e Markdown.Modo de navegação: Um único clique abre abas em itálico que são substituídas por novos cliques.
Modo de edição: Clique duas vezes ou edite para tornar as abas normais (impede a substituição).
Mais: Feche abas (todas, a atual ou as outras).
Use o clique duplo para abas persistentes durante a edição de vários elementos.
Seletor de ambiente#
Selecione ambientes para testar APIs. Alterne entre desenvolvimento, staging ou produção para garantir que as requisições usem as configurações corretas.Exemplo: Clique no menu suspenso de ambiente na área de trabalho para alterar contextos.Rodapé#
O rodapé fornece ferramentas de status e utilitários.| Recurso | Descrição |
|---|
| Recolher/Expandir | Alterne a visibilidade da árvore de diretórios. |
| Online | Mostra o status da conexão. O modo offline afeta a sincronização. |
| Agente | Selecione o agente para requisições (somente Apidog Web). |
| Cookies | Gerencie cookies. |
| Lixeira | Visualize itens excluídos (excluídos automaticamente após 30 dias). |
| Comunidade | Participe da comunidade Apidog no Discord, Slack, X ou por Email. |
Verifique o status Online para garantir a sincronização da equipe.
Próxima etapa
Aprenda conceitos básicos no Apidog 