Generador de documentación de API en Mewayz
El complemento de Generador de documentación de API ofrece una referencia navegable e integrada de la API REST de Mewayz.
módulo original de Mewayz — sin Mewayz aguas arriba. Documentación redactada a partir del código fuente del paquete en
packages/mewayz/ApiDocsGenerator/.
Introducción
El complemento Generador de Documentación de API ofrece a los operadores y desarrolladores externos una referencia de una sola página y con búsqueda para la API REST de Mewayz. Es el equivalente dentro de la app a una interfaz Swagger: cada endpoint documentado, esquema de solicitud, esquema de respuesta y carga de ejemplo se muestra dentro del panel de administración, de modo que un desarrollador nunca tiene que salir de la plataforma para integrar.
La superficie de documentación es basado en esquemas: el paquete carga archivos JSON prediseñados desde src/documentation/ (uno por dominio: items.json, project.json, account.json, etc.), indexados por un maestro config.json que indica qué dominios renderizar y sus nombres visibles. Esto significa que la documentación es fiel al contrato real: no se desvía de las rutas porque cada versión publica tanto las rutas como el esquema JSON correspondiente al mismo tiempo.
Cómo habilitar este módulo
Para configurar el complemento Generador de Documentación de API, puedes seguir este enlace: Configurar el complemento.
El complemento está restringido por PlanModuleCheck:ApiDocsGenerator. Actívalo en un plan o por inquilino mediante el Complementos página de administración; una vez activado, aparece una entrada "Documentación de la API" en la barra lateral.
How to Access the API Docs
- Inicia sesión en Mewayz y navega hasta Documentación de la API en la barra lateral.
- La referencia de una sola página se carga en
/api-docs. La ruta requiere autenticación- - La referencia está agrupada por dominio. Cada dominio lista cada
restringido (web + auth + verified + PlanModuleCheck), por lo que los visitantes anónimos son redirigidos a la página de inicio de sesión.
endpoint disponible con el verbo HTTP, la ruta, las cabeceras requeridas, el esquema del cuerpo de la solicitud y una respuesta de ejemplo.
Autenticación en la API de Mewayz
Todos los endpoints de la API de Mewayz documentados aquí están protegidos por **Laravel Sanctum** y requieren un token bearer en el Authorization encabezado. El tipo de contenido se aplica mediante el api.json middleware: cada solicitud debe incluir Content-Type: application/vnd.api+json (o el encabezado JSON equivalente) o la solicitud se rechaza antes de llegar al controlador.
Para emitir un token:
- Desde el menú de perfil del operador, abre API Tokens.
- Haz clic en Crear token, asígnale un nombre y copia el secreto de inmediato
- Pasa el token en cada llamada a la API:
Authorization: Bearer <token>.
(el secreto solo se muestra una vez).
Cobertura de endpoints
Los esquemas JSON incluidos cubren los siguientes dominios:
- Gestión de usuarios —
/api/users,/api/user/store|update|delete|reset-password|verify - Productos y servicios —
/api/products,/api/product/create|update|detail|delete, además de categorías, impuestos, unidades y existencias de almacén - Gestión de proyectos —
/api/projects,/api/project/{id}/task-board, hitos, seguimiento de errores - Facturación de ventas y compras —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Transferencias de almacén e inventario —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Propuestas de venta —
/api/sales-proposal - RRHH —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM y leads —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Contabilidad —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - TPV —
/api/pos
Permisos
Visibility of the API Docs entry in the sidebar is controlled by Spatie permission manage-api-docs. Los operadores sin este permiso no ven la entrada de menú y reciben un 403 si la visitan /api-docs directamente.
Notas del operador
- La documentación está solo lectura hoy mismo: no hay ningún "Pruébalo"
- Los esquemas JSON residen en el control de versiones en
- Los inquilinos de marca blanca ven automáticamente la documentación adaptada a
para ejecutar llamadas en vivo desde la página de documentación. (Usa una herramienta como Postman o curl para probar contra los endpoints documentados.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Cuando se publican nuevos endpoints de la API, el archivo JSON correspondiente se añade o amplía en la misma versión.
su propio nombre de marca y URL base; no es necesario mantener documentación independiente para cada inquilino.