Compartilhamento da documentação da API

Depois que sua API for desenvolvida e depurada com sucesso, o Apidog facilita a geração de documentação profissional que você pode compartilhar com sua equipe, stakeholders ou desenvolvedores externos.

Guia passo a passo

Siga estas etapas para gerar e compartilhar a documentação da sua API:

Etapa 1: Acesse o módulo Share Docs

1. Abra seu projeto no Apidog

2. Alterne para o módulo Share Docs na barra lateral

Etapa 2: Crie um novo compartilhamento

1. Clique no botão New para iniciar um novo compartilhamento de documentação
2. Isso abrirá a caixa de diálogo de configuração de compartilhamento

Etapa 3: Configure as definições de compartilhamento

Conclua as seguintes definições na configuração de compartilhamento:

Configuração	Descrição	Ação recomendada
Nome	Dê ao seu compartilhamento um nome descritivo	Use o nome do projeto + versão (por exemplo, "Pet Store API v1.2")
Ambientes	Selecione quais ambientes incluir	Selecione todos os ambientes para uma documentação abrangente
Acesso	Defina as permissões de visibilidade	Escolha o nível de acesso apropriado para o seu público


3. Clique em Save para criar seu compartilhamento

Etapa 4: Acesse sua documentação

1. Seu novo compartilhamento aparecerá na lista de compartilhamentos
2. Clique em Open para visualizar sua documentação em um navegador da web
3. A documentação será aberta em uma nova aba com uma URL compartilhável

Etapa 5: Explore os recursos da documentação

Sua documentação inclui recursos avançados:

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

• Try It Out: Envie requisições em tempo real diretamente da documentação

• Geração de código: Gere snippets de código de requisição e código de modelo de dados

• Alternância de ambiente: Teste diferentes ambientes de API

Personalização e publicação avançadas

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

Recurso	Descrição	Caso de uso
Layout personalizado	Modifique a estrutura e a aparência da documentação	Consistência da marca, otimização da experiência do usuário
Domínio personalizado	Use seu próprio nome de domínio	Apresentação profissional, reconhecimento da marca
URLs personalizadas	Crie URLs memoráveis e significativas	Marketing, compartilhamento fácil, benefícios de SEO
Controle de acesso	Defina permissões granulares	Equipes internas, parceiros externos, acesso público

---

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