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
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Publicar documentação de API
  • 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. Publicar documentação de API

CSS, JavaScript, HTML personalizados

Ao publicar a sua documentação de API, pode adicionar HTML, CSS e JavaScript globais personalizados para personalizar os estilos das páginas e expandir a funcionalidade.
Esta funcionalidade é útil para:
Incorporar serviços de terceiros (por exemplo, chatbots, assistentes de IA)
Modificar estilos predefinidos (por exemplo, tipo de letra, cor, fundo)
Adicionar elementos interativos (por exemplo, botões, popups, feedback rápido)
Ao utilizar esta funcionalidade de forma criteriosa, a sua documentação pode refletir melhor a identidade da sua marca e melhorar a experiência do utilizador.

CSS#

Com CSS personalizado, pode alterar tipos de letra, ocultar elementos, ajustar margens, alterar cores e muito mais.
Uma vez que a estrutura da documentação poderá mudar em atualizações futuras, recomendamos que siga estes dois princípios para garantir que os seus estilos continuam eficazes:
1.
Utilize variáveis CSS reservadas
2.
Utilize nomes de classes CSS reservados

Utilizar variáveis CSS reservadas#

O Apidog disponibiliza um conjunto de variáveis CSS com o prefixo --g- para controlar estilos básicos da página, como tipo de letra, cor e fundo. Estas variáveis adaptam-se bem aos modos claro e escuro, tornando os seus estilos mais estáveis e fáceis de manter.
Referência de variáveis comuns
Exemplo: Alterar a cor principal do texto

Utilizar nomes de classes CSS reservados#

Para direcionar áreas específicas para estilização, utilize os nomes de classes reservados do Apidog com o prefixo .g-, que são relativamente estáveis e menos propensos a deixar de funcionar devido a alterações no DOM.
Referência de classes CSS comuns
Exemplo: Ocultar a barra lateral esquerda

Inspecionar a estrutura da página e os nomes das classes#

Além das variáveis CSS reservadas e dos nomes de classes mencionados acima, também pode utilizar as ferramentas de programador do navegador para encontrar o nome da classe correspondente ao elemento da página que pretende modificar e, em seguida, escrever CSS para ajustar o estilo.
Recomenda-se que utilize primeiro nomes de classes que começam por .g-. Estes são reservados pela plataforma, têm uma estrutura relativamente estável e são menos propensos a falhar. Para outros nomes de classes estruturais, utilize-os com cautela para evitar falhas de estilo após atualizações do produto.
Pode abrir o site de documentação publicado no navegador e utilizar as ferramentas de programador (modo de programador/consola) para ver a estrutura da página e os nomes das classes de estilo:
Mac: Command + Option + Ioufn + F12
Windows: Ctrl + Shift + Ioufn + F12ouF12
Depois de abrir, clique no "Seletor de elementos" (o ícone do rato) e, em seguida, clique em qualquer área da página para ver as etiquetas HTML e os nomes de classes correspondentes a essa área.
Também pode utilizar a função de pesquisa (Cmd/Ctrl + F) para localizar um nome de classe.
image.png

JavaScript#

O JavaScript personalizado é utilizado para incorporar serviços de terceiros, como assistentes de IA ou widgets de suporte. Nota: o campo de JavaScript personalizado do Apidog não suporta etiquetas <script> ou <style>. Deve convertê-las em JavaScript puro. Por exemplo:
❌ Original (não suportado)
✅ Convertido para JavaScript puro
Se pretender incorporar um script ou estilo de terceiros, mas não tiver a certeza de como o reescrever em formato JS puro, pode copiar o prompt abaixo e colá-lo numa ferramenta de IA (como o Claude) para permitir que a IA o ajude a convertê-lo automaticamente:
I'm using Apidog's "Custom JavaScript" feature, which only allows pure JavaScript (no <script> or <style> tags).

Please convert the following code to pure JavaScript. Here are the requirements:
1. Rewrite the <script> tag to document.createElement('script') dynamic creation method;
2. Inject the <style> content into the newly created style tag and insert the head;
3. Please use standard methods (such as createElement, appendChild) for all DOM operations, and do not use document.write;
4. If the original code uses `window.addEventListener('DOMContentLoaded', ...)` or `window.addEventListener('load', ...)` only to wait for the page before running code, remove the event listener and run the code directly. Apidog executes custom JavaScript after the documentation page has been rendered, so the browser's `load` event may already have passed by that time; code registered inside a `load` listener may not be executed;
5. The final generated JavaScript should be able to run directly in the browser without any explanation.

Original code:
---
(paste your code here)
---
Por motivos de segurança, o JavaScript personalizado só funciona ao aceder à documentação através de domínio personalizado.
Se aceder através do endereço de documentação predefinido fornecido pelo Apidog (por exemplo, começando por https://xxx.apidog.io/), o JS personalizado não será carregado nem executado.
Certifique-se de que o código é fiável para evitar afetar o carregamento normal ou danificar a estrutura da página.
O JavaScript personalizado é executado depois de a página de documentação ter sido renderizada. Como o evento load do navegador pode já ter ocorrido nesse momento, o código colocado dentro de window.addEventListener('load', ...) poderá não ser executado. Na maioria dos casos, execute o seu código diretamente:

Exemplo: Caixa expansível/recolhível#

Clique no botão abaixo para expandir/recolher a caixa de diálogo do iframe
Script para "Clicar no botão para expandir/recolher a caixa de diálogo do iframe"
Como utilizar:
1
Cole o código na área "Custom JavaScript" do Apidog.
2
Visite os sites de documentação através do seu domínio personalizado.
3
É apresentado um botão no canto inferior direito; clique para abrir o iframe de chat.
4
Substitua iframe.src pelo seu serviço de IA, por exemplo:
CSS e JavaScript personalizados

Exemplo: Incorporar o widget Chatbase#

Script para "Incorporar o widget de chat Chatbase"
Como utilizar:
1
Crie uma aplicação Chatbase, obtenha o código de incorporação e converta-o para JS puro utilizando o prompt acima.
image.png
Cole o código convertido na secção Custom JS do Apidog.
2
Visite os sites de documentação através do seu domínio personalizado.
3
Será apresentado um botão no canto inferior direito. Clique nele para abrir uma janela de diálogo.
CSS e JavaScript personalizados

HTML#

A funcionalidade HTML está atualmente em desenvolvimento. Fique atento ao seu lançamento.

Perguntas frequentes#

O JS personalizado não funciona?
Certifique-se de que está a visitar a documentação através de um domínio personalizado. O JavaScript personalizado só é executado quando utiliza um domínio personalizado associado.
Devo utilizar 'load' ou 'DOMContentLoaded' em JavaScript personalizado?
Modified at 2026-06-09 08:54:45
Previous
Layouts personalizados
Next
Domínio Personalizado
Built with