Apidog Docs
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇵🇹 Português (Portugal)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. Desenvolver e depurar APIs
  • Centro de Aprendizagem da Apidog
  • Primeiros passos
    • Introdução ao Apidog
    • Conceitos Básicos no Apidog
    • Navegar no Apidog
    • Início rápido
      • Visão geral
      • Criar um Endpoint
      • Fazer um Pedido
      • Adicionar uma asserção
      • Criar Cenários de Teste
      • Partilhar Documentação da API
      • Explore Mais
    • Migração para o Apidog
      • Visão geral
      • Importação Manual
      • Importação Agendada (Vincular Fontes de Dados)
      • Opções de Importação
      • Exportar Dados
      • Importar de
        • Importar do Postman
        • Importar especificação OpenAPI
        • Importar cURL
        • Importar Markdowns
        • Importar a partir do Insomnia
        • Importar a partir de apiDoc
        • Importar Ficheiro .har
        • Importar WSDL
  • Apidog Europe
    • Apidog Europe
  • Dados de API mock
    • Visão geral
    • Smart Mock
    • Mock personalizado
    • Sequência de Prioridade do Mock
    • Scripts de Mock
    • Mock na Cloud
    • Mock do Runner Autoalojado
    • Idioma de Mock (Localidades)
  • Conta e preferências
    • Definições da Conta
    • Gerar um Token de Acesso OpenAPI
    • Notificações
    • Definições de Idioma
    • Teclas de Atalho
    • Configuração de Proxy de Rede
    • Cópia de Segurança dos Dados
    • Atualizar o Apidog
    • Eliminar Conta
    • Funcionalidades Experimentais
  • Enviar requisições
    • Visão geral
    • Depuração de SSE
    • Cliente MCP
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP ou WebService
    • GraphQL
    • gRPC
    • Utilizar Agentes de Proxy de Pedido para Depuração
    • Criar requisições
      • Histórico de Pedidos
      • Noções Básicas de Pedidos
      • Parâmetros e Corpo
      • Cabeçalhos do Pedido
      • Definições do Pedido
      • Depurar Pedidos
      • Guardar Pedidos como Endpoints
      • HTTP/2
    • Autenticação e autorização
      • Visão geral
      • Certificados CA e de Cliente
      • Tipos de autorização
      • Autenticação Digest
      • OAuth 1.0
      • OAuth 2.0
      • Autenticação Hawk
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Resposta e cookies
      • Visualizar Respostas de API
      • Gerir Cookies
      • Visão geral
  • Desenvolver e depurar APIs
    • Visão geral
    • Gerar Pedidos
    • Enviar Pedidos
    • Casos de Depuração
    • Casos de Teste
    • Valores Dinâmicos
    • Validação de Respostas
    • Design-First vs Request-First
    • Geração de Código
    • Ambientes e variáveis
      • Visão geral
      • Utilizar Variáveis
      • Gestão de Ambientes
    • Segredos do cofre
      • Visão geral
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Módulos de valores dinâmicos
      • Airline
      • Animal
      • Cor
      • Comércio
      • Empresa
      • Base de Dados
      • Tipo de dados
      • Data
      • Finanças
      • Alimentação
      • Git
      • Hacker
      • Helpers
      • Imagem
      • Internet
      • Localização
      • Lorem
      • Música
      • Número
      • Pessoa
      • Telefone
      • Ciência
      • String
      • Sistema
      • Veículo
      • Word
    • Pré e pós-processadores
      • Visão geral
      • Asserção
      • Extrair variável
      • Espera
      • Segurança
      • Operações de banco de dados
        • Visão geral
        • MySQL
        • MongoDB
        • Redis
        • Cliente Oracle
      • Uso de scripts
        • Visão geral
        • Scripts de Pré-processamento
        • Scripts de pós-processamento
        • Scripts Públicos
        • Referência de Scripts do Postman
        • Chamar Outras Linguagens de Programação
        • Utilizar Bibliotecas JS
        • Visualizar Respostas
        • Exemplos de scripts
          • Scripts de Asserção
          • Utilização de Variáveis
          • Modificar Pedidos
          • Outros exemplos
    • Depuração de APIs
      • Depurador de Agentes de IA
      • Depurador A2A
  • Projetar APIs
    • Visão geral
    • Criar um Novo Projeto de API
    • Noções Básicas de Endpoints
    • Diretrizes de Design de API
    • Módulo
    • Configurar vários exemplos de corpo do pedido
    • Componentes
    • Campos Comuns
    • Parâmetros Globais
    • Histórico de Alterações do Endpoint
    • Comentários
    • Gestão de Endpoints em Lote
    • API de Protocolo Personalizado
    • Modo Spec-first (Beta)
    • Esquemas de segurança
      • Visão geral
      • Criar um Esquema de Segurança
      • Utilizar o Esquema de Segurança
      • Esquema de Segurança na Documentação Online
    • Recursos avançados
      • Campos de Endpoint Personalizados
      • Cenários de Teste Associados
      • Estado do endpoint
      • Aparência das listas de parâmetros
      • Identificação Única de Endpoint
    • Schemas
      • Visão geral
      • Criar um Novo Schema
      • Criar um Schema
      • Gerar esquemas a partir de JSON, etc.
      • oneOf, allOf, anyOf
      • Utilizar Discriminator
  • Testes de API
    • Visão geral
    • Cenários de teste
      • Criar um Cenário de Teste
      • Passar Dados Entre Pedidos
      • Condições de Controlo de Fluxo
      • Sincronizar Dados de Endpoints e Casos de Endpoint
      • Importar Endpoints e Casos de Endpoint de Outros Projetos
      • Exportar Cenários de Teste
    • Relatórios de teste
      • Relatórios de Teste
    • Executar cenários de teste
      • Executar um cenário de teste
      • Executar cenários de teste em lote
      • Testes Orientados por Dados
      • Dados de Teste Partilhados
      • Tarefas agendadas
      • Gerir o ambiente de runtime de APIs de outros projetos
    • Suíte de testes
      • Visão geral
      • Criar Uma Suite de Testes
      • Orquestrar Conjunto de Testes
      • Executar Conjuntos de Testes Localmente
      • Executar conjuntos de testes via CLI
      • Tarefas agendadas
    • Testar APIs
      • Testes de Integração
      • Testes de desempenho
      • Testes de Ponta a Ponta
      • Teste de regressão
      • Testes de Contrato
    • Apidog CLI
      • Visão geral
      • Instalar e Executar o Apidog CLI
      • Opções da CLI do Apidog
    • CI/CD
      • Visão geral
      • Integrar com o Github Actions
      • Integrar com o Gitlab
      • Integrar com Jenkins
      • Acionar Teste por Commit Git
  • Publicar documentação de API
    • Visão geral
    • Tecnologias de API Suportadas
    • Partilha Rápida
    • Visualizar a Documentação da API
    • Documentação Markdown
    • Publicar Sites de Documentação
    • Página de Início de Sessão Personalizada
    • Layouts personalizados
    • CSS, JavaScript, HTML personalizados
    • Domínio Personalizado
    • Funcionalidades de IA
    • Definições de SEO
    • Configurações avançadas
      • Pesquisa na Documentação
      • Proxy CORS
      • Integrar o Google Analytics
      • Definições da Árvore de Pastas
      • Definições de Visibilidade
      • Incorporar Valores em URLs de Documentação
    • Versões da API
      • Visão geral
      • Criar Versões de API
      • Publicar versões de API
      • Partilhar Endpoints com Versões da API
  • Branches
    • Visão geral
    • Criar uma Branch de Sprint
    • Testar APIs numa Branch
    • Conceber APIs numa Ramificação
    • Mesclar Branches de Sprint
    • Gerir Branches de Sprint
    • AI Branch (Beta)
  • Recursos de IA
    • Visão geral
    • Ativar Funcionalidades de IA
    • Gerar Casos de Teste
    • Modificar esquemas com IA
    • Verificação de Conformidade do Endpoint
    • Verificação da Completude da Documentação da API
    • Nomeação de Campos com IA
    • Perguntas frequentes
  • Servidor MCP do Apidog
    • Visão geral
    • Ligar o Projeto Apidog à IA
    • Ligar Documentação Publicada à IA
    • Ligar Ficheiros OpenAPI à IA
  • Boas práticas
    • Tratamento de Assinaturas de API
    • Aceder a APIs Protegidas por OAuth 2.0
    • Fluxo de trabalho de colaboração
    • Gestão do Estado de Autenticação
  • Espaço offline
    • Visão geral
  • Administração
    • Gerenciamento de projetos
      • Gerir Projetos
      • Definições de Notificação
      • Gerir Membros do Projeto
      • Recursos do projeto
        • Ligação à Base de Dados
        • Ligação Git
    • Gerenciamento de equipes
      • Gerir Equipas
      • Gerir Membros da Equipa
      • Atividades da Equipa
      • Funções e permissões da equipa
      • Recursos da equipe
        • General Runner
        • Variáveis de Equipa
        • Agente Proxy de Pedidos
      • Colaborações em tempo real
        • Colaboração em Equipa
    • Checklist de integração
      • Conceitos Básicos
      • Guia de Integração Inicial
    • Gerenciamento da organização
      • Gerir a Organização
      • Funções e Permissões da Organização
      • Gerenciamento de planos
        • Gestores de Faturação em Organizações
      • Single Sign-On (SSO)
        • Visão Geral do SSO
        • Configurar o Microsoft Entra ID
        • Configurar o Okta
        • Configurar SSO para uma organização
        • Gerir Contas de Utilizador
        • Mapear Grupos para Equipas
      • Provisionamento SCIM
        • Introdução ao Provisionamento SCIM
        • Microsoft Entra ID
        • Okta
      • Recursos da organização
        • Self-Hosted Runner
  • Cobrança
    • Visão geral
    • Créditos
    • Atualizar o seu plano
    • Métodos de Pagamento Alternativos
    • Gestão de Subscrições
    • Mover Equipas Pagas para Organizações
  • Complementos
    • API Hub
    • Plugin Apidog Intellij IDEA
    • Extensão do navegador
      • Chrome
      • Microsoft Edge
    • Proxy de requisições
      • Proxy de pedidos na Web
      • Proxy de Pedidos em Documentação Partilhada
      • Proxy de Pedido no Cliente
  • Dados e segurança
    • Armazenamento e Segurança de Dados
    • Privacidade e Segurança dos Dados do Utilizador
    • Encaminhamento de Pedidos e Segurança dos Dados
  • Referências
    • Abordagem API Design-First
    • Extensões da Especificação OpenAPI do Apidog
    • JSONPath
    • XPath
    • Expressões Regulares
    • JSON Schema
    • Formato de ficheiro CSV
    • Instalar o Ambiente Java
    • Ambiente de Implementação do Runner
    • Sintaxe Markdown do Apidog
    • Extensões Swagger do Apidog
      • Visão geral
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Extensões JSON Schema do Apidog
      • Visão geral
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • Central de suporte
  1. Desenvolver e depurar APIs

Visão geral

Apidog fornece um conjunto completo de funcionalidades concebidas para tornar a depuração de APIs simples e eficiente, tirando partido das especificações de API para otimizar o processo de teste e desenvolvimento. Abaixo encontra-se uma visão geral das principais funcionalidades de depuração que o Apidog oferece.

Gerar pedidos automaticamente para depuração#

Apidog automatiza a criação de parâmetros e corpos de pedidos com base nas suas especificações de API, melhorando a precisão e a eficiência do processo de depuração.
Geração de pedidos: Cria automaticamente parâmetros e corpos de pedidos conforme definido na sua especificação de API, garantindo precisão e poupando tempo durante os testes.
Valores dinâmicos: Injeta valores realistas e dinâmicos nos seus pedidos, simulando cenários reais e ajudando a identificar potenciais problemas no tratamento de variações de dados.
Casos de depuração: Permite-lhe guardar configurações de parâmetros e corpos de pedidos como casos de endpoint que podem ser reutilizados, tornando os testes de regressão e os testes repetidos mais eficientes.

Testes visuais automatizados facilitados#

Com o Apidog, pode testar visualmente as respostas da sua API sem configuração manual, garantindo que a sua API se comporta conforme esperado em diferentes cenários.
Validação de respostas: Valida automaticamente as respostas da API em relação à sua especificação de API, detetando discrepâncias e garantindo a conformidade.
Testes de asserções visuais: Fornece uma GUI para criar asserções, facilitando a definição das condições que a resposta da sua API deve cumprir, sem escrever código extenso.
Compatibilidade total com scripts do Postman: Importe os seus scripts existentes do Postman para o Apidog para criação visual de asserções e testes automatizados, preservando os seus conjuntos de testes existentes e melhorando-os com as funcionalidades avançadas do Apidog.

Capacidades únicas que superam a concorrência#

Apidog oferece ferramentas únicas que o distinguem no mercado, facilitando testes de API mais abrangentes, particularmente benéficos para ambientes complexos.
Conectividade a bases de dados para CRUD na depuração de API: Ligue-se diretamente à sua base de dados a partir do Apidog para realizar operações CRUD no âmbito dos testes de API, o que é essencial para testes de ponta a ponta e sequências de API mais complexas.
Integração com linguagens de programação externas: Expanda as capacidades do Apidog através da integração com ambientes de programação externos, permitindo configurações e estruturas de testes personalizadas.
Suporte para arquitetura de microsserviços: Otimizado para funcionar de forma integrada com arquiteturas de microsserviços, fornecendo suporte robusto e facilitando a gestão e a depuração de aplicações baseadas em microsserviços.

Outras funcionalidades#

Apidog também oferece ferramentas adicionais e modos para melhorar as suas práticas de depuração e o fluxo de trabalho de desenvolvimento de APIs.
Design-First vs. Request-First: Alterne entre os modos de design e depuração para se concentrar na criação das suas especificações de API ou na depuração das suas implementações de API.
Geração de código: Gere automaticamente snippets de código em várias linguagens de programação para ajudar os programadores a integrar-se com a API ou a reproduzir problemas localmente.
Gerar automaticamente a especificação de API a partir de pedidos: Se a sua especificação de API estiver desatualizada ou em falta, o Apidog pode fazer engenharia inversa de uma especificação de API a partir dos pedidos.
Ao tirar partido do conjunto abrangente de funcionalidades de depuração do Apidog, os programadores podem reduzir significativamente o tempo e o esforço necessários para os testes de API, garantindo soluções de API robustas, fiáveis e escaláveis.

Boas práticas para diferentes equipas#

Para equipas API Design-First#

Assim que o design da API estiver concluído, a equipa de desenvolvimento backend pode utilizar a especificação de API para desenvolver e depurar a API. O Apidog oferece as seguintes funcionalidades de desenvolvimento e depuração:

Antes do desenvolvimento#

Geração de código: O Apidog permite a geração de SDKs de cliente, stubs de servidor e documentação de API em várias linguagens de programação com base na especificação de API. Este processo automatizado poupa tempo e garante consistência ao implementar APIs.

Após o desenvolvimento#

Geração de pedidos: O Apidog permite-lhe gerar pedidos com base na especificação de API.
Valores dinâmicos: Os valores dinâmicos permitem-lhe gerar um novo valor com base numa regra predefinida sempre que envia um pedido. Isto ajuda a otimizar o processo de depuração e garante que cada pedido contém dados únicos.
Ambientes e variáveis: O Apidog suporta a configuração de diferentes ambientes e serviços, permitindo que os programadores alternem entre definições para ambientes de desenvolvimento, teste e produção. Esta funcionalidade proporciona flexibilidade para testar APIs em várias condições.
Validação de respostas: Os programadores podem validar respostas de API em relação a esquemas ou critérios predefinidos para garantir que os dados devolvidos pela API cumprem o formato e o conteúdo esperados. Isto ajuda a manter a integridade e a consistência dos dados nas respostas de API.
Pré-processadores e pós-processadores: O Apidog permite a definição de etapas de pré-processamento e pós-processamento que podem ser executadas antes e depois de os pedidos de API serem enviados. Estas operações podem incluir manipulação de dados, registo, tratamento de erros ou quaisquer ações necessárias para preparar ou tratar a resposta da API.
Scripting: Os programadores têm a capacidade de escrever e executar scripts no Apidog, permitindo personalização avançada e automatização de tarefas durante o desenvolvimento e os testes de API. Os scripts podem ser utilizados para realizar operações complexas, interagir com sistemas externos ou melhorar a funcionalidade dos pedidos e respostas de API.
Casos de depuração: Um caso de endpoint no Apidog é um caso de teste predefinido para um endpoint de API específico, utilizado para simplificar o processo de criação, gestão e execução de testes de API, bem como para os integrar em fluxos de trabalho de testes automatizados.

Para equipas Code-First#

Se a sua equipa seguir uma abordagem de desenvolvimento Code-first, o Apidog fornece uma variedade de ferramentas para apoiar este fluxo de trabalho:
Plugin Apidog IDEA: Este plugin permite-lhe gerar especificações de API a partir do código, integrando de forma fluida o seu processo de desenvolvimento code-first com a criação de documentação de API.
Importação agendada: O Apidog oferece uma funcionalidade para sincronizar automaticamente a partir do Swagger, garantindo que a sua documentação de API se mantém atualizada com as alterações feitas no seu código.
Design-First vs. Request-First: Com a funcionalidade de modo de depuração, pode fazer modificações na especificação de API em tempo real durante a depuração, permitindo-lhe iterar o design da API enquanto desenvolve e testa o seu código.
Valores dinâmicos: Os valores dinâmicos permitem-lhe gerar um novo valor com base numa regra predefinida sempre que envia um pedido. Isto ajuda a otimizar o processo de depuração e garante que cada pedido contém dados únicos.
Ambientes e variáveis: O Apidog suporta a configuração de diferentes ambientes e serviços, permitindo que os programadores alternem entre definições para ambientes de desenvolvimento, teste e produção. Esta funcionalidade proporciona flexibilidade para testar APIs em várias condições.
Pré-processadores e pós-processadores: O Apidog permite a definição de etapas de pré-processamento e pós-processamento que podem ser executadas antes e depois de os pedidos de API serem enviados. Estas operações podem incluir manipulação de dados, registo, tratamento de erros ou quaisquer ações necessárias para preparar ou tratar a resposta da API.
Scripting: Os programadores têm a capacidade de escrever e executar scripts no Apidog, permitindo personalização avançada e automatização de tarefas durante o desenvolvimento e os testes de API. Os scripts podem ser utilizados para realizar operações complexas, interagir com sistemas externos ou melhorar a funcionalidade dos pedidos e respostas de API.
Casos de depuração: Um caso de endpoint no Apidog é um caso de teste predefinido para um endpoint de API específico, utilizado para simplificar o processo de criação, gestão e execução de testes de API, bem como para os integrar em fluxos de trabalho de testes automatizados.
Modified at 2026-06-09 08:54:45
Previous
Visão geral
Next
Gerar Pedidos
Built with