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
  • Back to home
  • Central de suporte
  • Centro de Suporte da Apidog
  • Importar/exportar
    • Como importar dados de API para o Apidog?
    • Como importar cURL no Apidog?
    • Como migrar ambientes do Postman para o Apidog?
    • Como agrupar automaticamente endpoints na importação de Swagger/OpenAPI?
  • Envio de requisições
    • O Apidog suporta Socket.IO?
    • Porque é que o "+" no valor do parâmetro é descodificado como um espaço?
    • Como enviar um pedido no Apidog?
    • Como enviar um pedido GraphQL no Apidog?
    • Como enviar um pedido gRPC no Apidog?
    • Como enviar um pedido SOAP/WebService no Apidog?
    • Como enviar um pedido WebSocket no Apidog?
    • O Apidog suporta scripts pré-pedido/teste e asserções em APIs WebSocket?
    • Como enviar um pedido SSE no Apidog?
    • Como adicionar cabeçalhos predefinidos ao nível da pasta?
    • O Apidog suporta scripts pré-pedido/de teste e asserções em APIs gRPC?
    • Erro do resolvedor DNS ELANREFUSED.DNS
    • Porque estou a receber um erro "socket hang up" ao enviar um pedido?
    • Correção de erros de requisição
      • Corrigir o erro read ECONNRESET
      • Corrigir o erro ECONNREFUSED
      • Corrigir o erro ETIMEDOUT
      • Corrigir o erro ENOTFOUND: Couldn't resolve host
      • Corrigir ENOTFOUND: getaddrinfo ENOTFOUND www Error
      • Corrigir o erro connect EHOSTUNREACH
  • Projeto de APIs
    • Como utilizo variáveis no caminho?
    • Posso utilizar um componente de resposta como resposta predefinida?
    • Como verificar quem modificou um endpoint?
    • Como posso eliminar pastas de endpoints em massa no Apidog?
    • Como posso adicionar/remover prefixos em massa ao caminho dos endpoints?
    • Como mover o nível de uma propriedade no Editor de Esquemas?
    • Se uma propriedade de string tiver vários valores enumerados e for utilizada em vários locais, como é que este enum pode ser referenciado de forma consistente em todo o lado?
    • Como obter o ID da pasta de recursos do Apidog?
    • Como posso obter o ID da pasta de recursos do Apidog?
    • Como utilizo variáveis num caminho de URL?
    • O que deve fazer se um endpoint, documento ou cenário de teste for eliminado acidentalmente?
    • O Apidog suporta código de pedido para endpoints personalizados?
    • Como agrupar automaticamente endpoints ao importar Swagger/OpenAPI para o Apidog?
    • Como gero dados de array não duplicados em respostas mock?
    • Porque é que a entrada "#" não é suportada no caminho?
  • Depuração de APIs
    • Como é que o Apidog se integra com sistemas de gestão de chaves de terceiros?
    • Porque é que o mesmo pedido funciona corretamente noutras ferramentas (como o Postman), mas não no Apidog?
    • Como obter valores de variáveis a partir da base de dados no Apidog?
    • Como migrar ambientes de outras ferramentas para o Apidog?
    • Como criar asserções utilizando scripts no Apidog?
    • JSONPath só consegue extrair arrays. Como podemos extrair um único elemento dentro deles no Apidog?
    • Como configurar operações de base de dados no Apidog quando diferentes ambientes têm diferentes credenciais de conta da base de dados?
    • Como obter o URL base do serviço num script personalizado?
    • Porque é que o Apidog comunica um erro de excesso do comprimento máximo de string do Node.js quando a resposta da API é demasiado grande?
    • Qual é o limite de tamanho para a impressão na consola? Porque recebo um erro ao imprimir ficheiros grandes?
    • Como resolver erros de ligação à base de dados DB2 no Windows?
    • Porque estou a obter o erro NJS-045 ao ligar-me a uma base de dados Oracle no Apidog?
    • Como gerar valores dinâmicos em scripts personalizados do Apidog?
    • Porque é que o pedido do cliente para o mesmo endpoint é bem-sucedido, mas ocorre um erro ao depurar no lado web: "Não é possível solicitar o endereço"?
    • Porque é que o Apidog comunica um erro quando a resposta é demasiado grande?
    • Como posso utilizar o endpoint de gravação do Apidog?
    • Ao definir uma resposta de endpoint, é permitido que o endpoint não tenha conteúdo de resposta?
    • Como obtenho a baseURL do serviço num script personalizado?
    • Como posso visualizar o pacote original no Apidog?
    • Porque é que vejo o erro "Invalid URI xxx" ao fazer um pedido?
    • Como faço um pedido assíncrono num script do Apidog?
    • Porque vejo a mensagem "Couldn't resolve host" ao enviar um pedido?
    • Qual é o limite de tamanho de impressão na consola? Porque ocorre um erro ao imprimir um ficheiro grande?
    • Como faço para carregar um ficheiro num pedido de endpoint?
    • O que fazer se o Apidog falhar ou os dados da resposta não forem apresentados?
    • URI de Redirecionamento Oficial utilizado pelo Apidog para OAuth2.0
  • Dados de API mock
    • Como simular APIs automaticamente?
    • O que pode fazer o mocking do Apidog?
    • Como fazer mock de dados fixos de API no Apidog?
    • Como simular dados condicionais no Apidog?
    • Como ativar o mock na cloud no Apidog?
    • Como ativar o mock autoalojado no Apidog?
    • O Apidog suporta mocks de APIs WebSocket?
    • Porque é que o browser não devolve conteúdo ao solicitar o endpoint mock?
  • Testes automatizados
    • Porque é que os cenários de teste são executados sem problemas no meu cliente local, mas ocorrem erros ao executá-los na CLI ou no runner do Apidog?
    • Como criar um cenário de teste no Apidog?
    • Como passar dados entre etapas de teste?
    • Porque não consigo referenciar com êxito dados do passo anterior?
    • Como utilizar o ciclo foreach no Apidog?
    • Quais são as diferenças entre sincronizar dados de endpoints/casos de endpoint?
    • Como utilizar dados de teste no Apidog?
    • Como obter dados de teste em scripts no Apidog?
    • Como executar cenários de teste em lote no Apidog?
    • Como agendar tarefas de teste no Apidog?
    • Como executar um teste de desempenho no Apidog?
    • Como pode visualizar os pedidos e as respostas reais nos testes de desempenho?
    • Como posso exportar relatórios de testes de desempenho no Apidog?
    • Como utilizar resultados de consultas à base de dados como parâmetros para pedidos de API em loop?
    • Capturar e Validar Webhooks do Stripe no ApiDog Durante CI/CD
    • Como resolver o erro "Error: unable to verify the first certificate on runner"?
    • Erro "Not Found" no Contentor Docker do General Runner.
    • Como definir o host do servidor para o General Runner na versão Web do Apidog?
    • Porque é que o cenário de teste agendado terminou com 0 pedidos?
    • O que deve fazer se o parâmetro de carregamento de ficheiro não for encontrado no Runner ou na CLI?
    • Como utilizar o Runner para executar um cenário de teste com um passo de carregamento de ficheiro?
    • Como resolvo o erro "Error: unable to verify the first certificate on runner"?
    • Como pode aceder e pesquisar os logs do runner para identificar o problema quando surge um problema com um runner?
    • O que devo fazer se o parâmetro do endpoint for um ficheiro de upload e não puder ser encontrado no Runner ou na CLI?
    • Porque é que os passos de teste não são sincronizados automaticamente quando o caso de uso da API muda?
    • Porque é que a utilização de vários sinais de dólar num documento Markdown faz com que algum conteúdo não seja apresentado corretamente?
    • O Runner autoalojado gera um relatório de teste no servidor após executar uma tarefa?
    • Posso adicionar pré/pós-processadores unificados a pedidos num cenário de teste?
    • Como posso manter valores dinâmicos consistentes durante uma única execução de teste automatizado?
  • Publicar documentação de API
    • Como ocultar todos os logótipos da Apidog em documentos publicados?
    • Quando a especificação da API é atualizada, a documentação da API muda?
    • Como partilhar APIs com colaboradores no Apidog?
    • Como personalizar o domínio das documentações do Apidog?
    • Como criar documentação multiversão no Apidog?
    • Âmbito de partilha para Sites de Documentação Publicados no Apidog
    • Âmbito de partilha da lista Share Doc no Apidog
    • Porque é que a documentação partilhada publicada não mostra o hostname?
    • Como podem os utilizadores da documentação modificar a URL Base em documentação partilhada?
    • Posso duplicar um documento Apidog publicado para usar no meu próprio projeto?
    • Como Partilhar Cabeçalhos (por exemplo, Token) na Documentação Online do Apidog?
    • Porque é que o membro da minha equipa não consegue encontrar a documentação publicada?
    • Como corrijo a expiração de um certificado SSL ou um erro 526 da Cloudflare no meu domínio personalizado?
    • SMTP personalizado configurado com sucesso, mas os utilizadores na lista de permissões não recebem e-mails com OTP
  • Markdown
    • Como utilizar cartões para ligar a várias páginas ou endpoints dentro do Apidog?
    • Porque é que algum conteúdo não é apresentado corretamente ao utilizar vários símbolos $ em documentos Markdown?
    • Como utilizar imagens com fundo transparente no Markdown do Apidog?
    • Como definir a largura das colunas de uma tabela Markdown?
    • Como pode inserir APIs internas, documentos, esquemas de dados ou pastas num documento Markdown?
    • Como posso adicionar uma ligação a um documento ou endpoint dentro de um projeto num componente de cartão do Apidog?
  • Ramos
    • Como aceder ao branch de sprint?
  • Administração
    • Como instalar o cliente Apidog silenciosamente?
    • Porque estou a ver um erro “No Permission” apesar de ter acesso de administrador?
    • Como posso verificar o número da versão do runner?
    • O Apidog suporta Windows 7?
    • Porque é que o Apidog apresenta o erro "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" após a instalação?
    • Alterações de Subscrição e Reembolsos
    • Os pedidos Web funcionam, mas a aplicação apresenta "read ECONNRESET" — Porquê?
    • Porque não consigo abrir o Apidog após uma atualização do sistema Windows?
    • Porque é que o Apidog não abre após uma atualização do sistema Windows
  • Cobrança
    • Posso configurar uma conta de faturação separada para a minha equipa no Apidog?
    • Problemas de Acesso da Equipa e Faturação no Apidog
    • O membro da equipa convidado não consegue aceder ao Apidog.
    • Transferir uma Equipa Paga Pessoal para uma Organização
  • On-premises
    • Gestão de utilizadores e acessos na versão Self-Hosted (Enterprise) do Apidog
  • Web e cliente
    • Transferência e instalação da versão de ambiente de trabalho para Linux
  1. Publicar documentação de API

Âmbito de partilha para Sites de Documentação Publicados no Apidog

P: O Apidog suporta a opção de selecionar um âmbito específico de endpoint/pasta/markdown para Sites de Documentação Publicados?
R: Sim, o Apidog suporta esta filtragem para que você possa disponibilizar itens seletivos para visualização por um público personalizado através da documentação publicada. No entanto, esta opção é suportada apenas para subsites; o site raiz não inclui a definição de âmbito como funcionalidade.
P: Como posso configurar o âmbito para Sites de Documentação Publicados?
R: Bem, esta definição de âmbito é suportada apenas para documentação não publicada e também para novos documentos publicados. Você pode seguir estes passos para a configurar, e a funcionalidade será implementada posteriormente.
1.
Selecione um documento não publicado/crie um novo site de documentação.
1c.png
Para a demonstração, selecionámos um site de documentação não publicado e, se você clicar no botão de edição assinalado, será encaminhado para uma nova janela.
1d.png
2.
Edite as definições de âmbito
Depois de clicar em Scope to publish, será redirecionado para a última janela pretendida, onde pode configurar a seleção personalizada em termos de endpoint, pastas e etiquetas. Também pode incluir/excluir etiquetas.
image.png
3.
Configure as opções de âmbito
Depois de configurar conforme necessário, certifique-se de que guarda as alterações e de que a definição de âmbito está a funcionar corretamente; em seguida, prossiga com a publicação. Para mais informações, pode ler Ler mais
P: Existe um risco de segurança se todas as pastas permanecerem visíveis?
R: Se as pastas estiverem a aparecer inesperadamente, recomendamos que verifique novamente as suas definições de âmbito seguindo os passos acima. Se o problema persistir num domínio personalizado, contacte o suporte do Apidog para obter assistência adicional.
Modified at 2026-06-09 08:54:45
Previous
Como criar documentação multiversão no Apidog?
Next
Âmbito de partilha da lista Share Doc no Apidog
Built with