Apidog Docs
🇧🇷 Português (Brasil)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇧🇷 Português (Brasil)
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇧🇷 Português (Brasil)
  • 🇺🇸 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 do 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 endpoints automaticamente na importação do Swagger/OpenAPI?
  • Envio de requisições
    • O Apidog oferece suporte a Socket.IO?
    • Por que o “+” no valor do parâmetro é decodificado como um espaço?
    • Como enviar uma requisição no Apidog?
    • Como enviar uma requisição GraphQL no Apidog?
    • Como enviar uma requisição gRPC no Apidog?
    • Como enviar uma requisição SOAP/WebService no Apidog?
    • Como enviar uma requisição WebSocket no Apidog?
    • O Apidog oferece suporte a scripts de pré-requisição/teste e assertivas em APIs WebSocket?
    • Como enviar uma requisição SSE no Apidog?
    • Como adicionar cabeçalhos padrão no nível da pasta?
    • O Apidog oferece suporte a scripts de pré-requisição/teste e assertivas em APIs gRPC?
    • Erro de resolvedor DNS ELANREFUSED.DNS
    • Por que estou recebendo um erro "socket hang up" ao enviar uma requisição?
    • Correção de erros de requisição
      • Corrigindo o erro read ECONNRESET
      • Corrigindo o erro ECONNREFUSED
      • Corrigindo o erro ETIMEDOUT
      • Corrigindo o erro ENOTFOUND: Couldn't resolve host
      • Corrigindo ENOTFOUND: getaddrinfo ENOTFOUND www Error
      • Corrigindo o erro connect EHOSTUNREACH
  • Projeto de APIs
    • Como usar variáveis no caminho?
    • Posso usar um componente de resposta como a resposta padrão?
    • Como verificar quem modificou um endpoint?
    • Como posso excluir 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 Schema?
    • Se uma propriedade de string tiver vários valores enumerados e for usada em diversos locais, como esse enum poderá ser referenciado de forma consistente em todos eles?
    • Como obter o ID da pasta de recursos do Apidog?
    • Como obtenho o ID da pasta de recursos do Apidog?
    • Como uso variáveis em um caminho de URL?
    • O que devo fazer se um endpoint, documento ou cenário de teste for excluído acidentalmente?
    • O Apidog oferece suporte a código de requisição para endpoints personalizados?
    • Como agrupar endpoints automaticamente ao importar Swagger/OpenAPI para o Apidog?
    • Como gerar dados de array sem duplicação em respostas mock?
    • Por que a entrada de "#" não é compatível no caminho?
  • Depuração de APIs
    • Como o Apidog se integra a sistemas de gerenciamento de chaves de terceiros?
    • Por que a mesma requisição funciona corretamente em outras ferramentas (como o Postman), mas não no Apidog?
    • Como buscar valores de variáveis no banco de dados no Apidog?
    • Como migrar ambientes de outras ferramentas para o Apidog?
    • Como criar assertivas usando scripts no Apidog?
    • JSONPath só consegue extrair arrays. Como podemos extrair um único elemento de dentro deles no Apidog?
    • Como configurar operações de banco de dados no Apidog quando ambientes diferentes têm credenciais de conta de banco de dados diferentes?
    • Como obter a URL base do serviço em um script personalizado?
    • Por que o Apidog relata um erro de exceder o comprimento máximo de string do Node.js quando a resposta da API é grande demais?
    • Qual é o limite de tamanho para impressão no console? Por que recebo um erro ao imprimir arquivos grandes?
    • Como resolver erros de conexão com banco de dados DB2 no Windows?
    • Por que estou recebendo o erro NJS-045 ao conectar a um banco de dados Oracle no Apidog?
    • Como gerar valores dinâmicos em scripts personalizados do Apidog?
    • Por que a requisição do cliente para o mesmo endpoint é bem-sucedida, mas ocorre um erro ao depurar no lado web: "Não foi possível solicitar o endereço"?
    • Por que o Apidog relata um erro quando a resposta é muito grande?
    • Como você usa 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 obter a baseURL do serviço em um script personalizado?
    • Como visualizar o pacote original no Apidog?
    • Por que estou vendo o erro "Invalid URI xxx" ao fazer uma requisição?
    • Como faço uma requisição assíncrona em um script do Apidog?
    • Por que vejo a mensagem "Couldn't resolve host" ao enviar uma requisição?
    • Qual é o limite de tamanho de impressão do console? Por que recebo um erro ao imprimir um arquivo grande?
    • Como faço upload de um arquivo em uma requisição de endpoint?
    • O que fazer se o Apidog travar ou os dados da resposta não forem exibidos?
    • URI de redirecionamento oficial usada pelo Apidog para OAuth2.0
  • Dados de API mock
    • Como simular APIs automaticamente?
    • O que o mock do Apidog pode fazer?
    • Como simular dados fixos de API no Apidog?
    • Como fazer mock de dados condicionais no Apidog?
    • Como habilitar o cloud mock no Apidog?
    • Como habilitar o mock auto-hospedado no Apidog?
    • O Apidog oferece suporte a mocks de APIs WebSocket?
    • Por que o navegador não retorna conteúdo ao solicitar o endpoint de mock?
  • Testes automatizados
    • Por que os cenários de teste são executados sem problemas no meu cliente local, mas ocorrem erros ao executá-los no Apidog CLI ou runner?
    • Como criar um cenário de teste no Apidog?
    • Como passar dados entre etapas de teste?
    • Por que não consigo referenciar dados da etapa anterior com sucesso?
    • Como usar o loop foreach no Apidog?
    • Quais são as diferenças entre sincronizar dados de endpoints/casos de endpoint?
    • Como usar dados de teste no Apidog?
    • Como recuperar 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 teste de desempenho no Apidog?
    • Como posso visualizar as requisições e respostas reais nos testes de desempenho?
    • Como posso exportar relatórios de teste de desempenho no Apidog?
    • Como usar resultados de consultas de banco de dados como parâmetros para requisições de API em loop?
    • Capture e valide 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 contêiner Docker do General Runner.
    • Como definir o host do servidor para o General Runner na versão Web do Apidog?
    • Por que o cenário de teste agendado terminou com 0 requisições?
    • O que devo fazer se o parâmetro de upload de arquivo não puder ser encontrado no Runner ou na CLI?
    • Como usar o Runner para executar um cenário de teste com uma etapa de upload de arquivo?
    • Como resolvo o erro "Error: unable to verify the first certificate on runner"?
    • Como você acessa e pesquisa os logs do runner para identificar o problema quando ocorre uma falha com um runner?
    • O que devo fazer se o parâmetro do endpoint for um arquivo de upload e não puder ser encontrado no Runner ou na CLI?
    • Por que as etapas de teste não são sincronizadas automaticamente quando o caso de uso da API é alterado?
    • Por que usar múltiplos sinais de dólar em um documento Markdown faz com que algum conteúdo não seja exibido corretamente?
    • O Runner auto-hospedado gera um relatório de teste no servidor após executar uma tarefa?
    • Posso adicionar pré/pós-processadores unificados a requisições em um 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 logotipos da Apidog em documentos publicados?
    • Quando a especificação da API for atualizada, a documentação da API será alterada?
    • Como compartilhar APIs com colaboradores no Apidog?
    • Como personalizar o domínio das documentações do Apidog?
    • Como criar documentação multiversão no Apidog?
    • Escopo de compartilhamento para Sites de Documentação Publicados no Apidog
    • Escopo de compartilhamento para a lista Share Doc no Apidog
    • Por que o Share Docs publicado não está mostrando o hostname?
    • Como os usuários da documentação podem modificar a URL base em documentações compartilhadas?
    • Posso duplicar um documento publicado do Apidog para usar no meu próprio projeto?
    • Como Compartilhar Cabeçalhos (por exemplo, Token) na Documentação Online do Apidog?
    • Por que meu membro da equipe não consegue encontrar a documentação publicada?
    • Como corrijo a expiração de um certificado SSL ou o erro Cloudflare 526 no meu domínio personalizado?
    • SMTP personalizado configurado com sucesso, mas usuários na lista de permissões não recebem e-mails de OTP
  • Markdown
    • Como usar cartões para vincular a várias páginas ou endpoints dentro do Apidog?
    • Por que alguns conteúdos não são exibidos corretamente ao usar vários símbolos $ em documentos Markdown?
    • Como usar imagens com fundo transparente no Markdown do Apidog?
    • Como definir a largura da coluna de uma tabela Markdown?
    • Como posso inserir APIs internas, documentos, esquemas de dados ou pastas em um documento Markdown?
    • Como adicionar um link para um documento ou endpoint dentro de um projeto em um componente de cartão do Apidog?
  • Branches
    • Como acessar a branch de sprint?
  • Administração
    • Como instalar o cliente Apidog silenciosamente?
    • Por que estou vendo um erro de “Sem permissão” apesar de ter acesso de administrador?
    • Como verifico o número da versão do runner?
    • O Apidog oferece suporte ao Windows 7?
    • Por que o Apidog mostra o erro "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" após a instalação?
    • Alterações de assinatura e reembolsos
    • As requisições web funcionam, mas o app recebe "read ECONNRESET" — por quê?
    • Por que não consigo abrir o Apidog após uma atualização do sistema Windows?
    • Por que o Apidog não abre após a atualização do sistema Windows
  • Cobrança
    • Posso configurar uma conta de cobrança separada para minha equipe no Apidog?
    • Problemas de acesso da equipe e faturamento no Apidog
    • Membro convidado da equipe não consegue acessar o Apidog.
    • Transferir uma equipe pessoal paga para uma organização
  • On-premises
    • Gerenciamento de usuários e acesso na versão Self-Hosted (Enterprise) do Apidog
  • Web e cliente
    • Download e instalação da versão desktop para Linux
  1. Publicar documentação de API

Escopo de compartilhamento para Sites de Documentação Publicados no Apidog

P: O Apidog oferece suporte à opção de selecionar um escopo específico de endpoint/pasta/markdown para Sites de Documentação Publicados?
R: Sim, o Apidog oferece suporte a essa filtragem para que você possa disponibilizar itens seletivos para visualização por um público personalizado por meio da documentação publicada. No entanto, essa opção é compatível apenas com subsites; o site raiz não possui o escopo como recurso.
P: Como posso configurar o escopo para Sites de Documentação Publicados?
R: Bem, esse escopo é compatível apenas com documentação não publicada e também com novos documentos publicados. Você pode seguir estas etapas para configurá-lo, e o recurso será implantado posteriormente.
1.
Selecione um Documento Não Publicado/crie um Novo Site de Documentação.
1c.png
Para a demonstração, selecionamos um site de documentação não publicado e, se você clicar no botão de edição marcado, ele levará você a uma nova janela.
1d.png
2.
Edite as Configurações de Escopo
Depois que você clicar em Escopo para publicar, haverá um redirecionamento para a última janela desejada, onde você poderá configurar a seleção personalizada em termos de endpoint, pastas e Tags. Você também pode incluir/excluir tags.
image.png
3.
Configure as Opções de Escopo
Depois de configurá-lo conforme necessário, certifique-se de salvá-lo e de que o escopo esteja funcionando corretamente, e prossiga com a publicação. Para mais informações, você pode ler Leia Mais
P: Há algum risco de segurança se todas as pastas permanecerem visíveis?
R: Se as pastas estiverem aparecendo inesperadamente, recomendamos verificar novamente suas configurações de escopo seguindo as etapas acima. Se o problema persistir em um domínio personalizado, entre em contato com o suporte do Apidog para obter mais assistência.
Modified at 2026-06-11 10:21:25
Previous
Como criar documentação multiversão no Apidog?
Next
Escopo de compartilhamento para a lista Share Doc no Apidog
Built with