Repolode
Enviar
Redocly

Redocly/redoc

Ferramenta open source que gera um site responsivo de referência de API, com três painéis, a partir de definições OpenAPI, Swagger, AsyncAPI ou GraphQL.

Alternativa open source a:SwaggerUI

Ver no GitHubSite
Estrelas
25,970
Forks
2,404
Issues abertas
366
Último commit
há 15 horas

O que é?

O Redoc transforma um arquivo de definição de API em uma página de documentação navegável. Ele oferece suporte a OpenAPI 3.2, 3.1, 3.0 e Swagger 2.0, além de AsyncAPI 3.x e GraphQL SDL, detectando o formato automaticamente. O layout padrão tem três painéis: uma barra de pesquisa e um menu de navegação à esquerda, a documentação no centro e exemplos de requisição e resposta à direita.

O Redoc pode ser usado de várias formas. Você pode gerar um arquivo HTML estático com o Redocly CLI usando npx, incorporar um elemento personalizado em uma página HTML que carrega uma URL de spec ou renderizá-lo como um componente React. É possível personalizar o tema com variáveis CSS; a ferramenta oferece suporte ao modo escuro e lê um conjunto de extensões do OpenAPI, como x-logo, x-tagGroups e x-codeSamples, para personalizar o resultado.

O projeto é mantido pela Redocly, e a versão comercial hospedada oferece recursos adicionais, como um painel try-it, mock server e linting.

Recursos principais

  • 01Renderiza definições OpenAPI 3.2/3.1/3.0 e Swagger 2.0
  • 02Oferece suporte a AsyncAPI 3.x e GraphQL SDL, com detecção automática de formato
  • 03Layout responsivo com três painéis e navegação sincronizada
  • 04Modo escuro e personalização de tema com variáveis CSS
  • 05Disponível como tag HTML, componente React, comando do Redocly CLI e imagem Docker

Casos de uso

  • Publicar documentação pública de referência de API a partir de um arquivo OpenAPI
  • Incorporar documentação de API a um site React ou HTML estático existente
  • Gerar um arquivo HTML independente para compartilhamento offline ou interno

Início rápido

  1. 1

    Gere a documentação a partir do seu arquivo OpenAPI com npx (requer Node).

    npx @redocly/cli build-docs openapi.yaml
  2. 2

    Abra o arquivo redoc-static.html gerado no navegador.

Antes de usar

  • A Community Edition não oferece recursos como o painel Try-it, servidor simulado e suporte a SOAP; eles estão disponíveis apenas no produto Redoc hospedado.
  • Por padrão, o Redoc coleta dados anônimos de uso e desempenho. Para desativar essa coleta, configure disable-telemetry ou disableTelemetry.

Tópicos

#api-documentation#openapi#swagger#documentation-generator#asyncapi#graphql#react#documentation-tool#hacktoberfest#openapi-specification

Perguntas frequentes

O que é redoc?
Ferramenta open source que gera um site responsivo de referência de API, com três painéis, a partir de definições OpenAPI, Swagger, AsyncAPI ou GraphQL. O Redoc transforma um arquivo de definição de API em uma página de documentação navegável. Ele oferece suporte a OpenAPI 3.2, 3.1, 3.0 e Swagger 2.0, além de AsyncAPI 3.x e GraphQL SDL, detectando o formato automaticamente. O layout padrão tem três painéis: uma barra de pesquisa e um menu de navegação à esquerda, a documentação no centro e exemplos de requisição e resposta à direita.
redoc é gratuito? Qual é a licença?
redoc é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
redoc ainda é mantido?
Manutenção ativa. O último commit de redoc foi em 20 de out. de 2026.
Para que posso usar redoc?
Publicar documentação pública de referência de API a partir de um arquivo OpenAPI Incorporar documentação de API a um site React ou HTML estático existente Gerar um arquivo HTML independente para compartilhamento offline ou interno
Como instalar redoc?
Gere a documentação a partir do seu arquivo OpenAPI com npx (requer Node).: npx @redocly/cli build-docs openapi.yaml Abra o arquivo redoc-static.html gerado no navegador.
Onde consigo redoc?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/Redocly/redoc

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados