Generatore di documenti API in Mewayz
Il componente aggiuntivo API Docs Generator fornisce un riferimento sfogliabile in-app per l'API REST Mewayz.
modulo originale Mewayz — no Mewayz a monte. Documentazione creata dall'origine del pacchetto su
packages/mewayz/ApiDocsGenerator/.
Introduzione
Il componente aggiuntivo API Docs Generator offre agli operatori e agli sviluppatori di terze parti un riferimento ricercabile in una sola pagina per l'API REST Mewayz. È l'equivalente in-app di un'interfaccia utente Swagger: ogni endpoint documentato, schema di richiesta, schema di risposta e payload di esempio viene visualizzato all'interno dell'amministratore in modo che uno sviluppatore non debba mai lasciare la piattaforma per l'integrazione.
La superficie della documentazione è guidato da schemi: il pacchetto carica file JSON predefiniti da src/documentation/ (uno per dominio: items.json, project.json, account.json, ecc.), codificato da un master config.json che elenca quali domini renderizzare e i loro nomi visualizzati. Questo significa che la documentazione è fedele al contratto reale — non si allontana dalle route perché ogni rilascio spedisce sia le route sia lo schema JSON corrispondente insieme.
Come abilitare questo modulo
Per impostare il componente aggiuntivo API Docs Generator, puoi seguire questo collegamento: Add-On di configurazione.
Il componente aggiuntivo è controllato da PlanModuleCheck:ApiDocsGenerator. Attivalo su un piano o per tenant tramite il Componenti aggiuntivi pagina di amministrazione; una volta attivo, nella barra laterale viene visualizzata la voce "API Docs".
Come accedere ai documenti API
- Accedi a Mewayz e vai a Documenti API nella barra laterale.
- Il riferimento a pagina singola viene caricato in
/api-docs. Il percorso è autentico - Il riferimento è raggruppato per dominio. Ogni dominio elenca ogni
recintato (web + auth + verified + PlanModuleCheck), quindi i visitatori anonimi vengono reindirizzati alla pagina di accesso.
endpoint disponibile con il verbo HTTP, il percorso, le intestazioni richieste, lo schema del corpo della richiesta e la risposta di esempio.
Autenticazione all'API Mewayz
Tutti gli endpoint API Mewayz documentati qui sono protetti da **Laravel Sanctum** e richiedono un token al portatore nel Authorization intestazione. Il tipo di contenuto viene applicato tramite il file api.json middleware: ogni richiesta deve includere Content-Type: application/vnd.api+json (o intestazione JSON equivalente) oppure la richiesta viene rifiutata prima di raggiungere il controller.
Per emettere un token:
- Dal menu del profilo dell'operatore, apri Token API.
- Fare clic Crea gettone, assegnagli un nome e copia immediatamente il segreto
- Passa il token a ogni chiamata API:
Authorization: Bearer <token>.
(il segreto viene mostrato solo una volta).
Copertura degli endpoint
Gli schemi JSON in bundle coprono i seguenti domini:
- Gestione utenti —
/api/users,/api/user/store|update|delete|reset-password|verify - Prodotti e servizi —
/api/products,/api/product/create|update|detail|delete, più categorie, tasse, unità, scorte di magazzino - Gestione del progetto —
/api/projects,/api/project/{id}/task-board, milestone, tracciamento dei bug - Fatturazione di vendite e acquisti —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Trasferimenti di magazzino e inventario —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Proposte di vendita —
/api/sales-proposal - Gestione delle risorse umane —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM e lead —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Contabilità —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - POS —
/api/pos
Autorizzazioni
La visibilità della voce Documenti API nella barra laterale è controllata dall'autorizzazione Spatie manage-api-docs. Gli operatori senza questa autorizzazione non vedono la voce del menu e ricevono un 403 se visitano /api-docs direttamente.
Note per l'operatore
- La documentazione è sola lettura oggi - non esiste il "Provalo"
- Gli schemi JSON risiedono nel controllo del codice sorgente in
- I tenant white label vedono automaticamente l'ambito della superficie dei documenti
pulsante per eseguire chiamate in tempo reale dalla pagina dei documenti. (Utilizzare uno strumento come Postman o curl per testare rispetto agli endpoint documentati.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Quando vengono spediti nuovi endpoint API, il file JSON corrispondente viene aggiunto o esteso nella stessa versione.
il proprio marchio e l'URL di base; non è necessario conservare alcuna documentazione separata per ogni inquilino.