Documentação em Markdown

O Apidog vai além da documentação de APIs ao permitir que você integre conteúdo rico em Markdown diretamente à sua documentação. Isso permite criar guias de usuário abrangentes que combinam perfeitamente referências de API com textos explicativos, tutoriais e exemplos. Documentos Markdown podem ser adicionados em vários níveis e exibidos junto com a documentação da API para uma experiência de documentação completa.

Documentos Markdown Independentes

Adicione documentos Markdown independentes a qualquer pasta de endpoints clicando no botão de mais (+). Escreva o conteúdo em Markdown no editor e visualize instantaneamente o resultado renderizado no painel à direita.

Markdown em Endpoints

Markdown também é compatível com o campo Descrição de cada endpoint. Qualquer Markdown que você adicionar aqui será renderizado como texto formatado na documentação da API, tornando as descrições dos seus endpoints claras e visualmente atraentes.

Markdown no Nível da Pasta

Adicione conteúdo em Markdown no nível da pasta para fornecer contexto e informações gerais. Quando os leitores clicarem no nome de uma pasta na documentação, verão o conteúdo em Markdown da pasta. Sem Markdown no nível da pasta, clicar em uma pasta simplesmente a expande para revelar seu conteúdo.

Para adicionar Markdown no nível da pasta:

Extensões de Markdown do Apidog

O Markdown do Apidog oferece suporte a uma variedade de estilos estendidos, incluindo Card, Accordion, Frame e outros. Esses componentes personalizados permitem que você crie experiências de documentação mais ricas e interativas.

Insira esses estilos facilmente por meio do editor Markdown clicando no botão Inserir, que fornece uma coleção de elementos disponíveis.

Saiba Mais

Saiba mais sobre Apidog Markdown.

Documentação em Markdown

Documentos Markdown Independentes#

Markdown em Endpoints#

Markdown no Nível da Pasta#

Extensões de Markdown do Apidog#

Documentos Markdown Independentes

Markdown em Endpoints

Markdown no Nível da Pasta

Extensões de Markdown do Apidog