Visão geral

O Apidog fornece capacidades de publicação poderosas que transformam as suas especificações de API em documentação profissional e interativa. Quer precise de partilhar APIs internamente com a sua equipa ou publicar documentação abrangente publicamente, o Apidog oferece opções flexíveis para satisfazer as suas necessidades — desde ligações de partilha rápida até sites de documentação totalmente personalizados com o seu próprio domínio.

Partilhe a sua documentação de API

O Apidog oferece várias formas de partilhar e publicar a sua documentação de API, cada uma concebida para diferentes casos de utilização:

Partilha rápida: Gere documentação de API apelativa com um único clique a partir das suas especificações de API definidas, ideal para colaboração rápida

Documentação interativa: Ative a funcionalidade "Experimentar" e a geração de código online para uma exploração prática da API

Sites de documentação: Publique sites de documentação abrangentes que combinam conteúdo Markdown com documentação de API para guias de utilizador completos

Navegação personalizada: Personalize a barra de navegação do seu documento para melhorar a experiência do utilizador

Domínios personalizados: Associe a documentação ao seu próprio domínio para uma marca profissional

URLs personalizados: Defina estruturas de URL de página personalizadas

Personalização de pastas: Personalize estilos de pastas e o comportamento ao clicar na sua documentação

Publicação multiversão: Publique e gira várias versões de API simultaneamente

Exemplo de documentação

Veja um exemplo real de documentação publicada: https://docs.salla.dev/

Tecnologias de API suportadas

O Apidog fornece suporte abrangente para documentar praticamente qualquer tecnologia de API. Quer esteja a trabalhar com APIs REST tradicionais, GraphQL moderno, ligações WebSocket em tempo real ou serviços SOAP empresariais, o Apidog tem a solução para si.

As tecnologias suportadas incluem: REST, SOAP, GraphQL, gRPC, WebSocket, SSE e muito mais.

Explore a nossa coleção de boas práticas de documentação e exemplos reais de APIs para ver como diferentes tipos de API podem ser documentados de forma eficaz.

Saber mais

Descubra guias detalhados e exemplos para cada tecnologia de API em Tecnologias de API suportadas.

Partilha rápida vs. Publicar documentação

O Apidog oferece dois métodos de publicação distintos, cada um otimizado para diferentes cenários. Compreender as diferenças entre ambos irá ajudá-lo a escolher a abordagem certa para as suas necessidades.

A Partilha rápida foi concebida para uma colaboração rápida e flexível — ideal para partilhar APIs específicas com membros da equipa ou parceiros externos durante o desenvolvimento. Publicar documentação foi criado para criar sites de documentação profissionais, orientados para o público, com capacidades de personalização completas.

Comparação de funcionalidades

Funcionalidade	Partilha rápida	Publicar documentação
Publicar APIs parciais	✓ Suportado	Apenas o projeto completo
Domínio personalizado	✗ Não suportado	✓ Suportado
Navegação personalizada	✗ Não suportado	✓ Suportado
Cores e logótipo personalizados	✗ Não suportado	✓ Suportado
Publicar no API Hub	✗ Não suportado	✓ Suportado

Recomendação

Utilize a Partilha rápida para colaboração interna e revisões rápidas de API. Utilize Publicar documentação quando precisar de um site de documentação profissional, com a sua marca, para consumo público.

Partilhe a sua documentação de API#

Tecnologias de API suportadas#

Partilha rápida vs. Publicar documentação#

Comparação de funcionalidades#

Partilhe a sua documentação de API

Tecnologias de API suportadas

Partilha rápida vs. Publicar documentação

Comparação de funcionalidades