Redocly

Redocly é uma plataforma de documentação de API que ajuda você a criar portais profissionais para desenvolvedores. Você começa com um arquivo OpenAPI que descreve sua API, e o Redocly o transforma em uma documentação limpa e legível, com exemplos e recursos interativos.

A plataforma inclui vários produtos que funcionam juntos. Reunite é onde as equipes escrevem e revisam o conteúdo. Realm entrega a documentação final aos seus usuários. Redoc é o motor de código aberto que gera a documentação de referência da API. Reef ajuda você a organizar e descobrir todas as suas APIs em um único catálogo.

Diferente dos geradores básicos de documentação, o Redocly oferece um portal completo para desenvolvedores. Você pode adicionar guias, tutoriais e páginas personalizadas junto com sua referência de API. Tudo é controlado por versões e atualiza automaticamente quando você altera a definição da sua API.

Começar com o Redocly é simples. Aqui estão os passos para criar sua documentação:

• Cadastre-se para uma conta Redocly e inicie seu teste gratuito no site deles.

• Conecte seu repositório de código do GitHub, GitLab ou Azure DevOps para sincronizar automaticamente seus arquivos OpenAPI.

• Faça upload ou vincule seu arquivo de definição OpenAPI. O Redocly suporta as versões 2.0, 3.0 e 3.1 do OpenAPI.

• Personalize a aparência alterando cores, fontes e adicionando seu logo para combinar com sua marca.

• Adicione páginas de conteúdo adicionais usando Markdown para guias, tutoriais e seções de introdução.

• Use o editor integrado para escrever e visualizar as alterações antes de publicá-las para seu público.

• Configure builds automáticos para que a documentação seja atualizada sempre que você alterar a definição da API em seu repositório.

• Configure seu domínio personalizado para hospedar a documentação no endereço do seu próprio site.

• Documentação automática de API a partir de arquivos OpenAPI

• Layout bonito de três painéis com navegação e exemplos

• Console interativo de API para testar endpoints

• Opções personalizadas de marca e estilo

• Fluxo de trabalho Git com atualizações automáticas

• Suporte a múltiplas versões de API

• Busca avançada com capacidades de IA

• Suporte a Markdown para guias e tutoriais

• Ferramentas de colaboração e revisão em equipe

• Hospedagem em domínio personalizado incluída