Publicação de sites de documentação

Publicar um site de documentação cria um espaço permanente e totalmente personalizado para a sua documentação de API — distinto do recurso Quick Share, que é projetado para colaboração temporária. Enquanto o Quick Share gera links compartilháveis para comunicação interna e externa rápida, o Publish Docs Sites oferece opções abrangentes de personalização, incluindo domínios personalizados, design com marca, controle de navegação e recursos avançados. Isso o torna ideal para criar documentação de API profissional e voltada ao público que representa a sua marca.

Pré-requisitos

Antes de publicar um site de documentação, certifique-se de que você tenha:

Uma conta Apidog com um projeto contendo documentação de API

Permissões de administrador para o projeto

(Opcional) Um domínio personalizado se você planeja usar URLs com a sua marca

Configurações preliminares

Publicação do seu site de documentação

Para publicar o seu site de documentação, navegue até o módulo Publish Docs e clique no site principal padrão; em seguida, clique no botão Publish.

Configurações de visibilidade do site de documentação

Requisito de versão

A versão do Apidog deve ser ≥ 2.7.15 para acessar estes recursos de visibilidade.

Depois de clicar no botão Publish, você pode controlar a visibilidade do seu site de documentação publicado com base nos seus requisitos de segurança e acesso. Clique no botão Publish right now para colocar o seu site no ar com as configurações de visibilidade escolhidas.

Público

Seus sites de documentação estarão acessíveis a todos os usuários da internet. Você também pode optar por publicar a sua documentação de API no API Hub, uma plataforma operada pela Apidog que ajuda os usuários a descobrir e explorar APIs.

Protegido por senha

Lista de permissões de IP

Lista de permissões de e-mail

Página de login personalizada

Escopo de publicação

Por padrão, o escopo para publicar a documentação é definido como todos os recursos Shared. Você pode configurar isso em APIs. Para obter mais detalhes, consulte configurações de visibilidade.

Configurações avançadas

Try It

Você pode habilitar o recurso Try It para as suas páginas de documentação, para que os usuários possam fazer requisições de API diretamente na própria página de documentação.

Versões de lançamento

Você pode criar e publicar várias versões da sua documentação de API. Saiba mais sobre a publicação de versões de API.

configurações de lançamento para documentações de API.jpg

Recursos relacionados

Como os usuários da documentação podem modificar a Base URL em documentações compartilhadas?

Como compartilhar cabeçalhos (por exemplo, Token) na documentação online do Apidog?

Configurações de domínio

Domínio fornecido pela Apidog: Seu documento terá um subdomínio padrão da Apidog, como https://vhh2uhkjv7.apidog.io. Você também pode modificá-lo manualmente. Todos os documentos da Apidog usam o domínio apidog.io.

Domínio personalizado: Você pode vincular o documento da Apidog ao seu próprio domínio. Saiba mais sobre domínio personalizado.

configurações de domínio para documentações de API.jpg

Personalização visual

Você pode personalizar a aparência e os layouts das documentações de API.

Você pode visualizar o seu documento em tempo real aqui e salvá-lo quando estiver satisfeito com o resultado.

Aparência

Layout e navegação

Página inicial personalizada

CSS, JavaScript e HTML personalizados

Em Configurações de aparência, você pode configurar várias opções básicas para a sua documentação de API, incluindo Title, Logo e Favicon.

Em Display content, você pode personalizar quais campos serão exibidos na documentação de API, incluindo: Base URL, Maintainer e Last Modified Time.

Configurações de SEO

Configuração	Descrição
Metadados globais	Configura os metadados padrão para todo o site.
Arquivo Robots	O arquivo `robots.txt` instrui os mecanismos de busca sobre quais páginas rastrear e exibir nos resultados de pesquisa.
Arquivo Sitemap	O arquivo `sitemap.xml` fornece aos mecanismos de busca uma lista abrangente de todas as páginas do seu site para melhor indexação.
Regras de redirecionamento da documentação	Redireciona os usuários para a página de documentação correta quando uma URL muda, evitando links quebrados.
Regras de URL e slug	Define a estrutura de URL e o formato de slug para as suas páginas de documentação.

Configurações avançadas

Recurso	Descrição
Pesquisa na documentação	Integra-se à Algolia para fornecer recursos de pesquisa aprimorados para a sua documentação de API publicada. O recurso Ask AI desbloqueia perguntas e respostas conversacionais com tecnologia de IA diretamente na pesquisa da sua documentação.
Proxy CORS	Especifica um proxy CORS para evitar problemas de origem cruzada que podem surgir de restrições de segurança do navegador.
Google Analytics	Habilita a integração com o Google Analytics para rastrear e analisar o tráfego para o seu site de documentação.
Publicar no API Hub	Publica a sua documentação no API Hub, uma plataforma aberta para compartilhar e descobrir APIs.
Descrição	Define a descrição que será exibida no API Hub se o projeto for publicado lá.
Permitir dados de 'Export', 'Clone'	Permite que os usuários exportem ou clonem os dados da documentação a partir da ramificação principal.

Publicar vários sites de documentação

Para publicar documentações em diferentes canais dentro do mesmo projeto, você pode criar sites de documentação adicionais durante a publicação. Para facilitar o gerenciamento, você pode duplicar a configuração do site principal para cada novo site. Cada subsite também pode ter um nome de domínio personalizado exclusivo.

introdução à publicação de sites de documentação-05.png

Somente subsites permitem definir o escopo de visibilidade para documentações publicadas, permitindo que você escolha quais recursos são acessíveis publicamente.

introdução à publicação de sites de documentação-06.png

Publicação de sites de documentação

Pré-requisitos#

Configurações preliminares#

Publicação do seu site de documentação#

Configurações de visibilidade do site de documentação#

Escopo de publicação#

Configurações avançadas#

Try It#

Versões de lançamento#

Configurações de domínio#

Personalização visual#

Configurações de SEO#

Configurações avançadas#

Publicar vários sites de documentação#

Pré-requisitos

Configurações preliminares

Publicação do seu site de documentação

Configurações de visibilidade do site de documentação

Escopo de publicação

Configurações avançadas

Try It

Versões de lançamento

Configurações de domínio

Personalização visual

Configurações de SEO

Configurações avançadas

Publicar vários sites de documentação