Publicar Sites de Documentação

Publicar um site de documentação cria uma localização permanente e totalmente personalizada para a sua documentação de API — distinta da funcionalidade Quick Share, que foi concebida para colaboração temporária. Enquanto o Quick Share gera links partilháveis para comunicação interna e externa rápida, o Publish Docs Sites disponibiliza opções de personalização abrangentes, incluindo domínios personalizados, design com marca, controlo de navegação e funcionalidades avançadas. Isto torna-o ideal para criar documentação de API profissional, orientada para o público, que representa a sua marca.

Pré-requisitos

Antes de publicar um site de documentação, certifique-se de que tem:

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

Permissões de administrador para o projeto

(Opcional) Um domínio personalizado se planear utilizar URLs com marca

Configurações Preliminares

Publicar o Seu Site de Documentação

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

Definições de Visibilidade do Site de Documentação

Requisito de Versão

A versão do Apidog deve ser ≥ 2.7.15 para aceder a estas funcionalidades de visibilidade.

Depois de clicar no botão Publish, 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 online com as definições de visibilidade escolhidas.

Público

Os seus sites de documentação estarão acessíveis a todos os utilizadores da Internet. Também pode optar por publicar a sua documentação de API no API Hub, uma plataforma operada pela Apidog que ajuda os utilizadores a descobrir e explorar APIs.

Protegido por palavra-passe

Lista de IPs Permitidos

Lista de Emails Permitidos

Página de Início de Sessão Personalizada

Âmbito de Publicação

Por predefinição, o âmbito para publicar documentação está definido para todos os recursos Shared. Pode configurar isto em APIs. Para obter mais detalhes, consulte as definições de visibilidade.

Configurações Avançadas

Try It

Pode ativar a funcionalidade Try It para as suas páginas de documentação, para que os utilizadores possam fazer pedidos de API diretamente na própria página de documentação.

Versões de Lançamento

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.

definições de lançamento para Documentações de API.jpg

Recursos Relacionados

Como Podem os Utilizadores da Documentação Modificar o URL Base em Documentos Partilhados?

Como Partilhar Cabeçalhos (por exemplo, Token) nos Documentos Online do Apidog?

Definições de Domínio

Domínio fornecido pela Apidog: O seu documento terá um subdomínio Apidog predefinido, como https://vhh2uhkjv7.apidog.io. Também pode modificá-lo manualmente. Todos os documentos Apidog utilizam o domínio apidog.io.

Domínio Personalizado: Pode associar o documento Apidog ao seu próprio domínio. Saiba mais sobre Domínio personalizado.

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

Personalização Visual

Pode personalizar a aparência e os esquemas das documentações de API.

Pode pré-visualizar o seu documento em tempo real aqui e guardá-lo quando estiver satisfeito com o resultado.

Aparência

Esquema e Navegação

Página Inicial Personalizada

CSS, JavaScript e HTML Personalizados

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

Em Display content, pode personalizar quais os campos a apresentar na documentação de API, incluindo: Base URL, Maintainer e Last Modified Time.

Definições de SEO

Definição	Descrição
Metadados Globais	Configura os metadados predefinidos para todo o site.
Ficheiro Robots	O ficheiro `robots.txt` instrui os motores de pesquisa sobre quais as páginas a rastrear e apresentar nos resultados de pesquisa.
Ficheiro Sitemap	O ficheiro `sitemap.xml` fornece aos motores de pesquisa uma lista abrangente de todas as páginas do seu site para uma melhor indexação.
Regras de Redirecionamento de Documentos	Redireciona os utilizadores para a página de documentação correta quando um 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.

Definições Avançadas

Funcionalidade	Descrição
Pesquisa na Documentação	Integra-se com o Algolia para fornecer capacidades de pesquisa melhoradas para a sua documentação de API publicada. A funcionalidade 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 devido a restrições de segurança do navegador.
Google Analytics	Permite a integração com o Google Analytics para acompanhar 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 partilhar e descobrir APIs.
Descrição	Define a descrição que será apresentada no API Hub se o projeto for publicado aí.
Permitir Dados de 'Export', 'Clone'	Permite que os utilizadores exportem ou clonem os dados da documentação a partir do ramo principal.

Publicar Vários Sites de Documentação

Para publicar documentos em diferentes canais dentro do mesmo projeto, pode criar sites de documentação adicionais durante a publicação. Para uma gestão mais fácil, 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

Apenas os subsites permitem definir o âmbito de visibilidade dos documentos publicados, permitindo-lhe escolher quais os recursos que ficam acessíveis publicamente.

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

Publicar Sites de Documentação

Pré-requisitos#

Configurações Preliminares#

Publicar o Seu Site de Documentação#

Definições de Visibilidade do Site de Documentação#

Âmbito de Publicação#

Configurações Avançadas#

Try It#

Versões de Lançamento#

Definições de Domínio#

Personalização Visual#

Definições de SEO#

Definições Avançadas#

Publicar Vários Sites de Documentação#

Pré-requisitos

Configurações Preliminares

Publicar o Seu Site de Documentação

Definições de Visibilidade do Site de Documentação

Âmbito de Publicação

Configurações Avançadas

Try It

Versões de Lançamento

Definições de Domínio

Personalização Visual

Definições de SEO

Definições Avançadas

Publicar Vários Sites de Documentação