Partilhar Documentação da API

Assim que a sua API estiver desenvolvida e depurada com sucesso, o Apidog facilita a geração de documentação profissional que pode partilhar com a sua equipa, partes interessadas ou programadores externos.

Guia Passo a Passo

Siga estes passos para gerar e partilhar a documentação da sua API:

Passo 1: Aceder ao Módulo Share Docs

1. Abra o seu projeto no Apidog

2. Mude para o módulo Share Docs a partir da barra lateral

Passo 2: Criar uma Nova Partilha

1. Clique no botão New para iniciar uma nova partilha de documentação
2. Isto abrirá a caixa de diálogo de configuração da partilha

Passo 3: Configurar as Definições de Partilha

Preencha as seguintes definições na configuração da partilha:

Definição	Descrição	Ação Recomendada
Name	Dê à sua partilha um nome descritivo	Utilize o nome do projeto + versão (por exemplo, "Pet Store API v1.2")
Environments	Selecione quais os ambientes a incluir	Selecione todos os ambientes para obter documentação abrangente
Access	Defina as permissões de visibilidade	Escolha o nível de acesso adequado para o seu público


3. Clique em Save para criar a sua partilha

Passo 4: Aceder à Sua Documentação

1. A sua nova partilha aparecerá na lista de partilhas
2. Clique em Open para ver a sua documentação num navegador Web
3. A documentação será aberta num novo separador com um URL partilhável

Passo 5: Explorar as Funcionalidades da Documentação

A sua documentação inclui funcionalidades avançadas:

• Explorador de API Interativo: Navegue pelos endpoints na árvore de diretórios à esquerda

• Try It Out: Envie pedidos em tempo real diretamente a partir da documentação

• Geração de Código: Gere excertos de código de pedidos e código de modelos de dados

• Mudança de Ambiente: Teste diferentes ambientes da API

Personalização e Publicação Avançadas

O Apidog oferece personalização adicional para a sua documentação:

Funcionalidade	Descrição	Caso de Utilização
Custom Layout	Modifique a estrutura e a aparência da documentação	Consistência da marca, otimização da experiência do utilizador
Custom Domain	Utilize o seu próprio nome de domínio	Apresentação profissional, reconhecimento da marca
Custom URLs	Crie URLs memoráveis e significativos	Marketing, partilha fácil, benefícios de SEO
Access Control	Defina permissões granulares	Equipas internas, parceiros externos, acesso público

---

Saiba mais sobre como conceber, testar, criar mocks e publicar APIs no Apidog.