API Doc Generator GrapesJS
Lo que incluye
- Gratis para descargar y usar
- Abierto para uso personal y comercial
Apoya a The Creator
Utiliza el apoyo puntual o mensual para agradecer al creador este producto gratuito.
GrapesJS Compatible
Probado con GrapesJS 0.22.x
Descarga gratuita
Descárgate y úsalo gratis en tus proyectos
Editor Compatible
Diseñado para el editor de código abierto GrapesJS
Gratis para usar
Abierto a proyectos personales y comerciales
GrapesJS API Doc Plugin
Coloca tablas y formularios en el lienzo GrapesJS — el plugin infiere automáticamente los endpoints de tu API REST y genera OpenAPI 3.1, una Colección Postman y datos simulados con un solo clic.
Lo que se infiere
| Componente de lienzo | Extremos inferidos |
|---|---|
| Tabla de datos | GET Lista + GET Detalle + PUT Actualización + DELETE |
| Crear / editar formulario | POST / PUT + esquema de cuerpo de solicitud |
| Barra de búsqueda | Inferencia de parámetros de consulta |
| Seleccionar el desplegable | Extracción de valores de enum |
| Nombres / etiquetas de columnas en chino | Nombres de campos en inglés (300+ mapeos) |
Exportar con un solo clic
- OpenAPI 3.1 JSON
- JSON de la colección Postman (importa directamente en Postman)
Inicio rápido
npm install grapesjs-plugin-apidoc import apiDocPlugin from 'grapesjs-plugin-apidoc'; grapesjs.init({ plugins: [apiDocPlugin] }); Construye tu página en el lienzo → haz clic en el botón API Docs en el panel superior derecho → tu documentación de la API esté lista.
Opciones
| Opción | Tipo | Default | Descripción |
|---|---|---|---|
apiPrefix | string | '/api' | Prefijo de ruta API |
btnLabel | string | 'API Docs' | Etiqueta de botón de panel |
autoScan | boolean | false | Escaneo automático al cargar |
panelId | string | 'options' | ID del panel que aloja el botón |
debug | boolean | false | Salida de escaneo verbosa en la consola |
Cómo funciona
CanvasScanner → TableAnalyzer + FormAnalyzer → APIInferrer → OpenAPI31Generator (component scan) (table / form inference) (dedupe) → PostmanGenerator → MockDataGenerator Licencia
MIT
Preguntas y respuestas
Aún no hay preguntas. ¿Tienes algo que preguntar?
Problemas comunes que este plugin puede ayudar a solucionar
Preguntas reales de la comunidad sobre el mismo tema — mira cómo otros se adaptaron a ellas.
- #4588💬 2 responde
API Docs Enlace de Configuración de Objeto roto
- #5715💬 1 responde
Enlace roto en la documentación de la API
- #5803💬 3 responde
Filtrar bloques no funciona como se describe en la documentación
- #5173💬 3 responde
Editor. La API de Css.setRule no funciona como se espera, no está actualizando la regla existente.
