מחולל אפי מסמכים mewayz

מחולל מסמכי API ב-Mewayz

תוסף ה-API Docs Generator מספק הפניה בתוך האפליקציה וניתנת לעיון עבור Mewayz REST API.

Mewayz-מודול מקורי - אין Mewayz במעלה הזרם. תיעוד נכתב ממקור החבילה בכתובת packages/mewayz/ApiDocsGenerator/.

במוצר

הקדמה

תוסף ה-API Docs Generator נותן למפעילים ולמפתחי צד שלישי הפניה של דף אחד שניתן לחיפוש עבור Mewayz REST API. זה המקבילה בתוך האפליקציה של ממשק המשתמש של Swagger - כל נקודת קצה מתועדת, סכימת בקשה, סכימת תגובה ועומס דוגמה מעובדים בתוך המנהל, כך שמפתח לעולם לא צריך לעזוב את הפלטפורמה כדי להשתלב.

משטח התיעוד הוא מונע על סכמה: החבילה טוענת קבצי JSON מובנים מראש src/documentation/ (אחד לכל דומיין: items.json, project.json, account.json וכו'), מקודם על ידי מאסטר config.json שמפרט אילו דומיינים לעבד ושמות התצוגה שלהם. זה אומר שהמסמכים מדויקים לחוזה בפועל - הם לא מתרחקים מהמסלולים מכיוון שכל מהדורה שולחת גם את המסלולים וגם את סכימת ה-JSON התואמת.

כיצד להפעיל מודול זה

כדי להגדיר את תוסף ה-API Docs Generator, אתה יכול לעקוב אחר הקישור הזה: הגדר תוסף.

התוסף נסגר על ידי PlanModuleCheck:ApiDocsGenerator. הפעל אותו בתוכנית או למשתכן דרך תוספות דף ניהול; לאחר הפעילות, ערך "API Docs" מופיע בסרגל הצד.

כיצד לגשת למסמכי ה-API

היכנס אל Mewayz ונווט אל API Docs בסרגל הצד.
הפניה של עמוד בודד נטענת ב /api-docs. המסלול הוא מאושר-

סגור (web + auth + verified + PlanModuleCheck), כך שמבקרים אנונימיים מופנים לדף ההתחברות.

ההפניה מקובצת לפי תחום. כל דומיין מפרט כל

נקודת קצה זמינה עם פועל ה-HTTP, הנתיב, הכותרות הנדרשות, סכימת גוף הבקשה ותגובה לדוגמה.

אימות ל-Mewayz API

כל נקודות הקצה של Mewayz API המתועדות כאן מוגנות על ידי **Laravel Sanctum** ודורשות אסימון נושא ב- Authorization כותרת. סוג התוכן נאכף באמצעות api.json תוכנת ביניים - כל בקשה חייבת לכלול Content-Type: application/vnd.api+json (או כותרת JSON מקבילה) או שהבקשה נדחתה לפני שהגיעה לבקר.

כדי להנפיק אסימון:

מתפריט הפרופיל של המפעיל, פתח אסימוני API.
לחץ צור אסימון, שם אותו והעתיק את הסוד מיד

(הסוד מוצג רק פעם אחת).

העבר את האסימון בכל קריאת API: Authorization: Bearer <token>.

כיסוי נקודות קצה

סכימות JSON המצורפות מכסות את הדומיינים הבאים:

ניהול משתמשים — /api/users, /api/user/store|update|delete|reset-password|verify
מוצרים ושירותים — /api/products, /api/product/create|update|detail|delete, בתוספת קטגוריות, מיסים, יחידות, מלאי מחסנים
ניהול פרויקטים — /api/projects, /api/project/{id}/task-board, אבני דרך, מעקב אחר באגים
חשבונית מכירה ורכישה — /api/sales-invoice, /api/sales-invoice-return, /api/purchase-invoice, /api/purchase-return
העברת מחסנים ומלאי — /api/warehouse, /api/warehouse/product/{warehouse_id}, /api/transfer
הצעות מכירה — /api/sales-proposal
HRM — /api/employees, /api/attendance, /api/leave-application, /api/payrolls
CRM & לידים — /api/leads, /api/deal/*, /api/pipeline, /api/lead-stage, /api/labels, /api/sources
הנהלת חשבונות — /api/chart-of-accounts, /api/customers, /api/vendors, /api/bank-accounts, /api/revenues, /api/expenses
קופה — /api/pos

הרשאות

הנראות של הערך API Docs בסרגל הצד נשלטת על ידי הרשאת Spatie manage-api-docs. מפעילים ללא הרשאה זו אינם רואים את ערך התפריט ומקבלים 403 אם הם מבקרים /api-docs ישירות.

הערות מפעיל

התיעוד הוא לקריאה בלבד היום - אין "נסה את זה"

לחצן לביצוע שיחות בשידור חי מדף המסמכים. (השתמש בכלי כמו Postman או curl כדי לבדוק מול נקודות הקצה המתועדות.)

סכימות JSON חיות בבקרת מקור ב

packages/mewayz/ApiDocsGenerator/src/documentation/. כאשר נקודות קצה חדשות של API נשלחות, קובץ ה-JSON התואם נוסף או מורחב באותה מהדורה.

דיירים עם תווית לבנה רואים באופן אוטומטי את משטח המסמכים בטווח של

שם המותג וכתובת האתר הבסיסית שלהם; אין צורך לשמור תיעוד נפרד לכל דייר.