Visão geral

O Apidog oferece recursos avançados de publicação que transformam suas especificações de API em documentação profissional e interativa. Seja para compartilhar APIs internamente com sua equipe ou publicar documentação abrangente publicamente, o Apidog oferece opções flexíveis para atender às suas necessidades — desde links de compartilhamento rápido até sites de documentação totalmente personalizados com seu próprio domínio.

Compartilhe sua documentação de API

O Apidog oferece várias formas de compartilhar e publicar sua documentação de API, cada uma projetada para diferentes casos de uso:

Compartilhamento rápido: Gere uma documentação de API elegante com um único clique a partir das especificações de API definidas, ideal para colaboração rápida

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

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

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

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

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

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

Publicação de múltiplas versões: Publique e gerencie várias versões de API simultaneamente

Documentação de exemplo

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

Tecnologias de API compatíveis

O Apidog oferece suporte abrangente para documentar praticamente qualquer tecnologia de API. Seja trabalhando com APIs REST tradicionais, GraphQL moderno, conexões WebSocket em tempo real ou serviços SOAP empresariais, o Apidog atende às suas necessidades.

As tecnologias compatíveis incluem: REST, SOAP, GraphQL, gRPC, WebSocket, SSE e muito mais.

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

Saiba mais

Descubra guias detalhados e exemplos para cada tecnologia de API em Tecnologias de API compatíveis.

Compartilhamento rápido vs. Publicar documentação

O Apidog oferece dois métodos distintos de publicação, cada um otimizado para diferentes cenários. Entender as diferenças entre eles ajudará você a escolher a abordagem certa para suas necessidades.

Compartilhamento rápido foi projetado para colaboração rápida e flexível — ideal para compartilhar APIs específicas com membros da equipe ou parceiros externos durante o desenvolvimento. Publicar documentação foi criado para desenvolver sites de documentação profissionais e voltados ao público, com recursos completos de personalização.

Comparação de recursos

Recurso	Compartilhamento rápido	Publicar documentação
Publicar APIs parciais	✓ Compatível	Apenas o projeto inteiro
Domínio personalizado	✗ Não compatível	✓ Compatível
Navegação personalizada	✗ Não compatível	✓ Compatível
Cores e logotipo personalizados	✗ Não compatível	✓ Compatível
Publicar no API Hub	✗ Não compatível	✓ Compatível

Recomendação

Use Compartilhamento rápido para colaboração interna e revisões rápidas de API. Use Publicar documentação quando você precisar de um site de documentação profissional, com identidade visual da marca e voltado ao público.

Compartilhe sua documentação de API#

Tecnologias de API compatíveis#

Compartilhamento rápido vs. Publicar documentação#

Comparação de recursos#

Compartilhe sua documentação de API

Tecnologias de API compatíveis

Compartilhamento rápido vs. Publicar documentação

Comparação de recursos