Redoc

Un visor de documentación de API de código abierto que genera documentación hermosa, responsiva e interactiva a partir de archivos de especificación OpenAPI (Swagger).

Qué puedes hacer después del despliegue

1. Visita tu dominio — Ve la documentación predeterminada de la API Petstore renderizada con Redoc
2. Carga tu propia especificación — Apunta Redoc a tu URL de especificación OpenAPI/Swagger JSON o YAML mediante la variable de entorno SPEC_URL
3. Explora el diseño de tres paneles — Navega por el menú izquierdo, el contenido central y los ejemplos de código a la derecha
4. Busca en la API — Usa la búsqueda integrada para encontrar rápidamente endpoints y esquemas
5. Comparte enlaces profundos — Copia URLs que enlazan directamente a endpoints o esquemas específicos

Características principales

• Diseño responsivo de tres paneles con menú, contenido y ejemplos de código
• Compatible con especificaciones OpenAPI 3.1, 3.0 y Swagger 2.0
• Ejemplos de solicitud/respuesta interactivos con muestras en múltiples lenguajes
• Funcionalidad de búsqueda integrada en todos los endpoints y esquemas
• Enlaces profundos a operaciones, etiquetas y esquemas específicos
• Generación automática de ejemplos de código
• Soporte de renderizado del lado del servidor para SEO
• Temas y opciones de marca personalizables
• Soporte de Markdown en descripciones
• Diseño responsivo compatible con dispositivos móviles

Licencia

MIT — GitHub