Repolode
Enviar
Redocly

Redocly/redoc

Herramienta de código abierto que genera un sitio adaptable de referencia de API, con tres paneles, a partir de definiciones de OpenAPI, Swagger, AsyncAPI o GraphQL.

Alternativa open source a:SwaggerUI

Ver en GitHubSitio web
Estrellas
25,970
Forks
2,404
Issues abiertos
366
Último commit
hace 14 horas

¿Qué es?

Redoc convierte un archivo de definición de API en una página de documentación navegable. Es compatible con OpenAPI 3.2, 3.1 y 3.0, así como con Swagger 2.0; también admite AsyncAPI 3.x y GraphQL SDL, y detecta el formato automáticamente. El diseño predeterminado tiene tres paneles: una barra de búsqueda y un menú de navegación a la izquierda, la documentación en el centro y ejemplos de solicitudes y respuestas a la derecha.

Redoc se puede usar de varias maneras. Puedes generar un archivo HTML estático con Redocly CLI mediante npx, insertar un elemento personalizado en una página HTML que cargue la URL de una especificación o renderizarlo como componente de React. Se puede personalizar con variables CSS, admite el modo oscuro y lee varias extensiones de OpenAPI, como x-logo, x-tagGroups y x-codeSamples, para adaptar el resultado.

El proyecto está a cargo de Redocly, y la versión comercial alojada añade funciones como un panel para probar la API, un servidor simulado y análisis de estilo.

Funciones clave

  • 01Renderiza definiciones de OpenAPI 3.2/3.1/3.0 y Swagger 2.0
  • 02Admite AsyncAPI 3.x y GraphQL SDL, con detección automática del formato
  • 03Diseño adaptable de tres paneles con navegación sincronizada
  • 04Modo oscuro y personalización mediante variables CSS
  • 05Disponible como etiqueta HTML, componente de React, comando de Redocly CLI e imagen de Docker

Casos de uso

  • Publicar documentación pública de referencia de una API a partir de un archivo OpenAPI
  • Insertar documentación de API en un sitio existente de React o HTML estático
  • Generar un archivo HTML independiente para compartirlo sin conexión o de forma interna

Inicio rápido

  1. 1

    Genera la documentación a partir de tu archivo OpenAPI con npx (requiere Node).

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

    Abre el archivo redoc-static.html generado en tu navegador.

Antes de usarlo

  • Community Edition no incluye funciones como el panel Try-it, el servidor simulado ni la compatibilidad con SOAP; solo están disponibles en el producto Redoc alojado.
  • Redoc recopila datos anónimos de uso y rendimiento de forma predeterminada, así que debes configurar disable-telemetry o disableTelemetry para excluirte.

Temas

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

Preguntas frecuentes

¿Qué es redoc?
Herramienta de código abierto que genera un sitio adaptable de referencia de API, con tres paneles, a partir de definiciones de OpenAPI, Swagger, AsyncAPI o GraphQL. Redoc convierte un archivo de definición de API en una página de documentación navegable. Es compatible con OpenAPI 3.2, 3.1 y 3.0, así como con Swagger 2.0; también admite AsyncAPI 3.x y GraphQL SDL, y detecta el formato automáticamente. El diseño predeterminado tiene tres paneles: una barra de búsqueda y un menú de navegación a la izquierda, la documentación en el centro y ejemplos de solicitudes y respuestas a la derecha.
¿redoc es gratuito? ¿Qué licencia tiene?
redoc es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿redoc sigue mantenido?
Mantenimiento activo. El último commit de redoc fue el 20 oct 2026.
¿Para qué puedo usar redoc?
Publicar documentación pública de referencia de una API a partir de un archivo OpenAPI Insertar documentación de API en un sitio existente de React o HTML estático Generar un archivo HTML independiente para compartirlo sin conexión o de forma interna
¿Cómo se instala redoc?
Genera la documentación a partir de tu archivo OpenAPI con npx (requiere Node).: npx @redocly/cli build-docs openapi.yaml Abre el archivo redoc-static.html generado en tu navegador.
¿Dónde consigo redoc?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/Redocly/redoc

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados