API Documentengenerator in Mewayz
De API Docs Generator Add-On biedt een in-app, bladerbare referentie voor de Mewayz REST API.
Mewayz-originele module — geen Mewayz stroomopwaarts. Documentatie geschreven vanuit pakketbron op
packages/mewayz/ApiDocsGenerator/.
Introductie
De API Docs Generator Add-On biedt operators en externe ontwikkelaars een doorzoekbare referentie van één pagina voor de Mewayz REST API. Het is het in-app-equivalent van een Swagger-gebruikersinterface: elk gedocumenteerd eindpunt, verzoekschema, antwoordschema en voorbeeldpayload wordt binnen de beheerder weergegeven, zodat een ontwikkelaar nooit het platform hoeft te verlaten om te integreren.
Het documentatieoppervlak is schemagestuurd: het pakket laadt vooraf gebouwde JSON-bestanden van src/documentation/ (één per domein: items.json, project.json, account.json, etc.), gecodeerd door een master config.json waarin wordt vermeld welke domeinen moeten worden weergegeven en hun weergavenamen. Dit betekent dat de documenten nauwkeurig zijn ten opzichte van het daadwerkelijke contract: ze wijken niet af van de routes, omdat bij elke release zowel de routes als het bijbehorende JSON-schema samen worden verzonden.
Hoe deze module in te schakelen
Om de API Docs Generator Add-On in te stellen, kunt u deze link volgen: Add-on instellen.
De Add-On wordt afgesloten door PlanModuleCheck:ApiDocsGenerator. Activeer het op een plan of per huurder via de Add-ons beheerderspagina; eenmaal actief verschijnt er een vermelding "API Docs" in de zijbalk.
Hoe u toegang krijgt tot de API-documenten
- Log in op Mewayz en navigeer naar API-documenten in de zijbalk.
- De verwijzing naar één pagina wordt geladen op
/api-docs. De route is officieel - De referentie is gegroepeerd per domein. Bij elk domein worden alle
afgesloten (web + auth + verified + PlanModuleCheck), zodat anonieme bezoekers worden doorgestuurd naar de inlogpagina.
beschikbaar eindpunt met het HTTP-werkwoord, het pad, de vereiste headers, het hoofdtekstschema van de aanvraag en het voorbeeldantwoord.
Authenticatie bij de Mewayz API
Alle hier gedocumenteerde Mewayz API-eindpunten worden beschermd door **Laravel Sanctum** en vereisen een bearer-token in de Authorization koptekst. Het inhoudstype wordt afgedwongen via de api.json middleware — elk verzoek moet dit bevatten Content-Type: application/vnd.api+json (of gelijkwaardige JSON-header) of het verzoek wordt afgewezen voordat het de controller bereikt.
Een token uitgeven:
- Open het profielmenu van de operator API-tokens.
- Klik Token maken, geef het een naam en kopieer het geheim onmiddellijk
- Geef het token door bij elke API-aanroep:
Authorization: Bearer <token>.
(het geheim wordt slechts één keer getoond).
Eindpuntdekking
De gebundelde JSON-schema's bestrijken de volgende domeinen:
- Gebruikersbeheer —
/api/users,/api/user/store|update|delete|reset-password|verify - Producten en diensten —
/api/products,/api/product/create|update|detail|delete, plus categorieën, belastingen, eenheden, magazijnvoorraden - Projectmanagement —
/api/projects,/api/project/{id}/task-board, mijlpalen, bugtracking - Sales & Purchase Invoicing —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Magazijn- en voorraadoverdrachten —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Verkoopvoorstellen —
/api/sales-proposal - HRM —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM en leads —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Boekhouding —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - POS —
/api/pos
Machtigingen
De zichtbaarheid van het API Docs-item in de zijbalk wordt bepaald door de toestemming van Spatie manage-api-docs. Operators zonder deze toestemming zien het menu-item niet en krijgen een 403 als ze bezoeken /api-docs direct.
Opmerkingen van de operator
- De documentatie is alleen-lezen vandaag - er is geen "Probeer het"
- De JSON-schema's bevinden zich in bronbeheer op
- Whitelabel-tenants zien automatisch de documenten waarop het bereik betrekking heeft
knop om oproepen live uit te voeren vanaf de documentenpagina. (Gebruik een tool zoals Postman of curl om te testen tegen de gedocumenteerde eindpunten.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Wanneer nieuwe API-eindpunten worden verzonden, wordt het overeenkomende JSON-bestand in dezelfde release toegevoegd of uitgebreid.
hun eigen merknaam en basis-URL; er hoeft geen aparte documentatie per huurder bijgehouden te worden.