Api docs generator mewayz

API Docs Generator i Mewayz

API Docs Generator-tilføjelsen giver en reference i appen til Mewayz REST API, der kan gennemses.

Mewayz-originalt modul — nej Mewayz opstrøms. Dokumentation forfattet fra pakkekilde på packages/mewayz/ApiDocsGenerator/.

Demo URL

Indledning

API Docs Generator Add-On giver operatører og tredjepartsudviklere en en-sides søgbar reference til Mewayz REST API. Det svarer til en Swagger-brugergrænseflade i appen - hvert dokumenteret slutpunkt, anmodningsskema, svarskema og eksempel på nyttelast gengives inde i administratoren, så en udvikler aldrig behøver at forlade platformen for at integrere.

Dokumentationsfladen er skemadrevet: pakken indlæser forudbyggede JSON-filer fra src/documentation/ (én pr. domæne: items.json, project.json, account.json osv.), indtastet af en master config.json der viser, hvilke domæner der skal gengives, og deres viste navne. Dette betyder, at dokumenterne er nøjagtige i forhold til den faktiske kontrakt – de driver ikke væk fra ruterne, fordi hver udgivelse sender både ruterne og det matchende JSON-skema sammen.

Sådan aktiverer du dette modul

For at konfigurere API Docs Generator-tilføjelsen kan du følge dette link: Opsætning af tilføjelse.

Tilføjelsen er lukket af PlanModuleCheck:ApiDocsGenerator. Aktiver det på en plan eller per-lejer via Tilføjelser admin side; når den er aktiv, vises en "API Docs"-indgang i sidebjælken.

Sådan får du adgang til API-dokumenterne

• Log ind på Mewayz og naviger til API-dokumenter i sidebjælken.
• Enkeltsidereferencen indlæses kl /api-docs. Ruten er autoriseret

gated (web + auth + verified + PlanModuleCheck), så anonyme besøgende omdirigeres til login-siden.

• Referencen er grupperet efter domæne. Hvert domæne viser hver

tilgængeligt slutpunkt med HTTP-verbet, stien, påkrævede overskrifter, anmodningstekstskema og eksempelsvar.

Godkendelse til Mewayz API

Alle Mewayz API-endepunkter, der er dokumenteret her, er beskyttet af **Laravel Sanctum** og kræver et bærer-token i Authorization overskrift. Indholdstypen håndhæves via api.json middleware — hver anmodning skal indeholde Content-Type: application/vnd.api+json (eller tilsvarende JSON-header), eller anmodningen afvises, før den når controlleren.

Sådan udsteder du et token:

• Åbn operatørens profilmenu API-tokens.
• Klik Opret token, navngiv det, og kopier hemmeligheden med det samme

(hemmeligheden vises kun én gang).

• Send tokenet ved hvert API-kald: Authorization: Bearer <token>.

Slutpunktsdækning

De medfølgende JSON-skemaer dækker følgende domæner:

• Brugerstyring — /api/users, /api/user/store|update|delete|reset-password|verify
• Produkter og tjenester — /api/products, /api/product/create|update|detail|delete, plus kategorier, skatter, enheder, lagerbeholdninger
• Projektledelse — /api/projects, /api/project/{id}/task-board, milepæle, fejlsporing
• Salg & Købsfakturering — /api/sales-invoice, /api/sales-invoice-return, /api/purchase-invoice, /api/purchase-return
• Lager- og lageroverførsler — /api/warehouse, /api/warehouse/product/{warehouse_id}, /api/transfer
• Salgsforslag — /api/sales-proposal
• HRM — /api/employees, /api/attendance, /api/leave-application, /api/payrolls
• CRM og kundeemner — /api/leads, /api/deal/*, /api/pipeline, /api/lead-stage, /api/labels, /api/sources
• Regnskab — /api/chart-of-accounts, /api/customers, /api/vendors, /api/bank-accounts, /api/revenues, /api/expenses
• POS — /api/pos

Tilladelser

Synligheden af API Docs-indgangen i sidebjælken styres af Spatie-tilladelse manage-api-docs. Operatører uden denne tilladelse kan ikke se menuindgangen og modtager en 403, hvis de besøger /api-docs direkte.

Operatør noter

• Dokumentationen er skrivebeskyttet i dag - der er ingen "Prøv det"

knappen for at udføre opkald live fra dokumentsiden. (Brug et værktøj som Postmand eller curl for at teste mod de dokumenterede endepunkter.)

• JSON-skemaerne lever i kildekontrol kl

packages/mewayz/ApiDocsGenerator/src/documentation/. Når nye API-slutpunkter sendes, tilføjes eller udvides den matchende JSON-fil i samme udgivelse.

• White-label-lejere ser automatisk dokumentoverfladen målt efter

deres eget mærkenavn og basis-URL; der skal ikke vedligeholdes særskilt dokumentation pr. lejer.