API-Docs-Generator in Mewayz
Das API Docs Generator Add-On bietet eine durchsuchbare In-App-Referenz für die Mewayz REST API.
Mewayz-Originalmodul — nein Mewayz stromaufwärts. Dokumentation aus der Paketquelle unter erstellt
packages/mewayz/ApiDocsGenerator/.
Einführung
Das API Docs Generator Add-On bietet Betreibern und Drittentwicklern eine einseitige, durchsuchbare Referenz für die Mewayz REST API. Es ist das In-App-Äquivalent einer Swagger-Benutzeroberfläche – jeder dokumentierte Endpunkt, jedes Anforderungsschema, jedes Antwortschema und jede Beispielnutzlast wird innerhalb des Administrators gerendert, sodass ein Entwickler die Plattform nie für die Integration verlassen muss.
Die Dokumentationsfläche ist schemagesteuert: Das Paket lädt vorgefertigte JSON-Dateien aus src/documentation/ (eine pro Domain: items.json, project.json, account.json usw.), verschlüsselt durch einen Master- config.json die auflistet, welche Domains gerendert werden sollen und ihre Anzeigenamen. Das bedeutet, dass die Dokumentation dem tatsächlichen Vertrag entspricht — sie weicht nicht von den Routes ab, weil jedes Release sowohl die Routes als auch das passende JSON-Schema gemeinsam ausliefert.
So aktivieren Sie dieses Modul
Um das API-Docs-Generator-Add-on einzurichten, folgen Sie diesem Link: Einrichtungs-Add-on.
Das Add-on ist freigeschaltet durch PlanModuleCheck:ApiDocsGenerator. Aktivieren Sie es auf einem Tarif oder pro Mandant über die Add-Ons Admin-Seite; sobald aktiv, erscheint ein Eintrag „API Docs“ in der Seitenleiste.
So greifen Sie auf die API-Docs zu
- Melden Sie sich bei Mewayz an und navigieren Sie zu API-Dokumentation in der Seitenleiste.
- Die einseitige Referenz lädt unter
/api-docs. Die Route ist auth- - Die Referenz ist nach Domain gruppiert. Jede Domain listet jeden
zugangsbeschränkt (web + auth + verified + PlanModuleCheck), sodass anonyme Besucher zur Login-Seite weitergeleitet werden.
verfügbaren Endpunkt mit HTTP-Verb, Pfad, erforderlichen Headern, Schema des Anfragetexts und Beispielantwort.
Authentifizierung bei der Mewayz API
Alle hier dokumentierten Mewayz API-Endpunkte sind durch **Laravel Sanctum** geschützt und erfordern ein Bearer-Token im Authorization Header. Der Content-Type wird erzwungen über den api.json Middleware — jede Anfrage muss enthalten Content-Type: application/vnd.api+json (oder ein gleichwertiger JSON-Header), sonst wird die Anfrage abgewiesen, bevor sie den Controller erreicht.
Um ein Token auszustellen:
- Öffnen Sie im Profilmenü des Betreibers API-Tokens.
- Klicken Sie auf Token erstellen, benennen Sie es und kopieren Sie das Secret sofort
- Übergeben Sie das Token bei jedem API-Aufruf:
Authorization: Bearer <token>.
(das Geheimnis wird nur einmal angezeigt).
Endpoint-Abdeckung
Die mitgelieferten JSON-Schemas decken die folgenden Bereiche ab:
- Nutzerverwaltung —
/api/users,/api/user/store|update|delete|reset-password|verify - Produkte & Dienstleistungen —
/api/products,/api/product/create|update|detail|delete, plus Kategorien, Steuern, Einheiten, Lagerbestände - Projektmanagement —
/api/projects,/api/project/{id}/task-board, Meilensteine, Bug-Tracking - Verkaufs- & Einkaufsrechnungen —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Lager- & Bestandstransfers —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Verkaufsangebote —
/api/sales-proposal - HRM —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM & Leads —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Buchhaltung —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - POS —
/api/pos
Berechtigungen
Die Sichtbarkeit des Eintrags „API Docs“ in der Seitenleiste wird durch die Spatie-Berechtigung gesteuert manage-api-docs. Bediener ohne diese Berechtigung sehen den Menüeintrag nicht und erhalten einen 403, wenn sie ihn aufrufen /api-docs direkt.
Betreibernotizen
- Die Dokumentation ist schreibgeschützt heute — es gibt kein „Probier es aus“
- Die JSON-Schemas liegen in der Versionsverwaltung unter
- White-Label-Mandanten sehen automatisch die Docs-Oberfläche, beschränkt auf
Schaltfläche, um Aufrufe direkt von der Doku-Seite live auszuführen. (Verwenden Sie ein Tool wie Postman oder curl um gegen die dokumentierten Endpunkte zu testen.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Wenn neue API-Endpunkte erscheinen, wird die passende JSON-Datei im selben Release hinzugefügt oder erweitert.
ihren eigenen Markennamen und ihre eigene Basis-URL; es muss keine separate Dokumentation pro Mandant gepflegt werden.