A interface principal do Apidog está dividida nestas áreas principais:Cabeçalho: Navegação superior com gestão de projetos e definições de utilizador.
Barra lateral: Painel esquerdo para aceder às funcionalidades principais.
Área de trabalho: Área central com árvore de diretórios, separadores e seletor de ambiente.
Rodapé: Barra inferior para estado, ferramentas e ligações da comunidade.
Cabeçalho#
O cabeçalho fornece acesso rápido a funções essenciais.| Funcionalidade | Descrição |
|---|
| Início | Aceda à sua página inicial pessoal com equipas, projetos e hub de APIs. |
| Separadores de projeto | Alterne entre projetos. Clique no botão junto ao nome para abrir numa nova janela. |
| Atualizar/Plano | Veja o plano atual da sua equipa. |
| Atualizar | Recarregue os dados do projeto. Nota: Isto fecha todos os separadores abertos. |
| Definições | Configure definições locais, como aparência e proxy. |
| Notificações | Consulte alertas de atividade da equipa. |
| Avatar | Faça a gestão das definições da conta e dos tokens de acesso. |
Para alternar entre projetos, clique em qualquer separador de projeto no cabeçalho.
Barra lateral#
A barra lateral organiza as funcionalidades principais do Apidog.| Funcionalidade | Descrição |
|---|
| Ícone do projeto | Aceda à visão geral de equipas e projetos. |
| APIs | Defina, depure, envie pedidos, crie schemas e escreva documentação. |
| Testes | Execute pedidos em lote, crie cenários, veja relatórios e faça a gestão de CI/CD. |
| Partilhar documentação | Partilhe e publique documentação de API com opções de personalização. |
| Histórico | Veja e reenvie pedidos enviados. |
| Definições | Faça a gestão das definições do projeto, notificações e dados. |
| Convidar | Convide utilizadores para o projeto. |
Utilize a barra lateral para aceder rapidamente a funcionalidades usadas com frequência, como APIs e Testes.
Área de trabalho#
A área de trabalho é o espaço central para gerir elementos do projeto.Árvore de diretórios#
A árvore de diretórios organiza hierarquicamente os componentes do projeto.| Funcionalidade | Descrição |
|---|
| Ramos e versões | Alterne entre ramos ou faça a gestão de versões. A predefinição é o ramo principal. |
| Pesquisa e filtro | Pesquise endpoints (não pastas nem casos). |
| Criar novo | Adicione endpoints, pedidos, schemas, etc. |
| <Nome do projeto> | Vista de alto nível do projeto. |
| Endpoints | Organize endpoints e casos em pastas. |
| Schemas | Faça a gestão de schemas em pastas. |
| Componentes | Componentes de resposta reutilizáveis. |
| API de administração | Contém ferramentas para o administrador processar dados em lote |
| Pedidos rápidos | Organiza pedidos rápidos efetuados neste projeto |
Para criar um novo endpoint, clique no ícone Criar novo na árvore de diretórios.
Separadores#
Ao clicar num elemento, é aberto um separador. Os separadores suportam tipos como Endpoint, Schema, Pedido e Markdown.Modo de navegação: Um único clique abre separadores em itálico que são substituídos por novos cliques.
Modo de edição: Faça duplo clique ou edite para tornar os separadores normais (impede a substituição).
Mais: Feche separadores (todos, o atual ou os outros).
Utilize o duplo clique para separadores 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 os pedidos utilizam as definições corretas.Exemplo: Clique no menu pendente de ambiente na área de trabalho para alterar contextos.Rodapé#
O rodapé fornece ferramentas de estado e utilitários.| Funcionalidade | Descrição |
|---|
| Recolher/Expandir | Alterne a visibilidade da árvore de diretórios. |
| Online | Mostra o estado da ligação. Estar offline afeta a sincronização. |
| Agente | Selecione o agente para pedidos (apenas Apidog Web). |
| Cookies | Faça a gestão de cookies. |
| Lixo | Veja itens eliminados (eliminados automaticamente após 30 dias). |
| Comunidade | Junte-se à comunidade Apidog no Discord, Slack, X ou por Email. |
Verifique o estado Online para garantir a sincronização da equipa.
Próximo passo
Aprenda os conceitos básicos no Apidog 