Mewayz में एपीआई डॉक्स जेनरेटर
एपीआई डॉक्स जेनरेटर ऐड-ऑन Mewayz REST API के लिए एक इन-ऐप, ब्राउज़ करने योग्य संदर्भ प्रदान करता है।
Mewayz-मूल मॉड्यूल - नहीं Mewayz अपस्ट्रीम। दस्तावेज़ीकरण पैकेज स्रोत से लिखा गया है
packages/mewayz/ApiDocsGenerator/.
परिचय
एपीआई डॉक्स जेनरेटर ऐड-ऑन ऑपरेटरों और तृतीय-पक्ष डेवलपर्स को Mewayz REST API के लिए एक-पेज, खोजने योग्य संदर्भ देता है। यह स्वैगर यूआई के इन-ऐप समकक्ष है - प्रत्येक दस्तावेजित समापन बिंदु, अनुरोध स्कीमा, प्रतिक्रिया स्कीमा और उदाहरण पेलोड को व्यवस्थापक के अंदर प्रस्तुत किया जाता है ताकि डेवलपर को एकीकृत करने के लिए कभी भी प्लेटफ़ॉर्म छोड़ना न पड़े।
दस्तावेज़ीकरण सतह है स्कीमा-चालित: पैकेज पूर्व-निर्मित JSON फ़ाइलों को लोड करता है src/documentation/ (प्रति डोमेन एक: आइटम.जेसन, प्रोजेक्ट.जेसन, अकाउंट.जेसन, आदि), एक मास्टर द्वारा कुंजीबद्ध config.json यह सूचीबद्ध करता है कि कौन से डोमेन प्रस्तुत करने हैं और उनके प्रदर्शन नाम क्या हैं। इसका मतलब यह है कि दस्तावेज़ वास्तविक अनुबंध के लिए सटीक हैं - वे मार्गों से दूर नहीं जाते हैं क्योंकि प्रत्येक रिलीज़ दोनों मार्गों और मिलान JSON स्कीमा को एक साथ भेजता है।
इस मॉड्यूल को कैसे सक्षम करें
एपीआई डॉक्स जेनरेटर ऐड-ऑन सेट अप करने के लिए, आप इस लिंक का अनुसरण कर सकते हैं: सेटअप ऐड-ऑन.
ऐड-ऑन द्वारा गेट किया गया है PlanModuleCheck:ApiDocsGenerator. इसे किसी योजना या प्रति-किरायेदार पर सक्रिय करें ऐड-ऑन व्यवस्थापक पृष्ठ; एक बार सक्रिय होने पर, साइडबार में एक "एपीआई डॉक्स" प्रविष्टि दिखाई देती है।
एपीआई डॉक्स तक कैसे पहुंचें
- Mewayz में साइन इन करें और नेविगेट करें एपीआई दस्तावेज़ साइडबार में.
- एकल-पृष्ठ संदर्भ यहां लोड होता है
/api-docs. मार्ग प्रामाणिक है- - संदर्भ को डोमेन द्वारा समूहीकृत किया गया है। प्रत्येक डोमेन प्रत्येक को सूचीबद्ध करता है
गेटेड (web + auth + verified + PlanModuleCheck), इसलिए अनाम आगंतुकों को लॉगिन पृष्ठ पर पुनः निर्देशित किया जाता है।
HTTP क्रिया, पथ, आवश्यक हेडर, अनुरोध बॉडी स्कीमा और उदाहरण प्रतिक्रिया के साथ उपलब्ध समापन बिंदु।
Mewayz एपीआई को प्रमाणित किया जा रहा है
यहां प्रलेखित सभी Mewayz एपीआई एंडपॉइंट **लारवेल सैंक्टम** द्वारा संरक्षित हैं और इसमें एक बियरर टोकन की आवश्यकता होती है Authorization शीर्षक. सामग्री-प्रकार को इसके माध्यम से लागू किया जाता है api.json मिडलवेयर - प्रत्येक अनुरोध में शामिल होना चाहिए Content-Type: application/vnd.api+json (या समकक्ष JSON हेडर) या नियंत्रक तक पहुंचने से पहले अनुरोध अस्वीकार कर दिया जाता है।
टोकन जारी करने के लिए:
- ऑपरेटर के प्रोफ़ाइल मेनू से, खोलें एपीआई टोकन.
- क्लिक करें टोकन बनाएं, इसे नाम दें, और रहस्य को तुरंत कॉपी करें
- प्रत्येक एपीआई कॉल पर टोकन पास करें:
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 - मानव संसाधन विकास मंत्री —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - सीआरएम और लीड्स —
/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
अनुमतियाँ
साइडबार में एपीआई डॉक्स प्रविष्टि की दृश्यता स्पैटी अनुमति द्वारा नियंत्रित की जाती है manage-api-docs. इस अनुमति के बिना ऑपरेटर मेनू प्रविष्टि नहीं देखते हैं और यदि वे जाते हैं तो उन्हें 403 प्राप्त होता है /api-docs सीधे.
ऑपरेटर नोट्स
- दस्तावेज़ीकरण है केवल पढ़ने के लिए आज - कोई "इसे आज़माएं" नहीं है
- JSON स्कीमा स्रोत नियंत्रण में रहते हैं
- व्हाइट-लेबल किरायेदार स्वचालित रूप से दस्तावेज़ सतह को दायरे में देखते हैं
दस्तावेज़ पृष्ठ से लाइव कॉल निष्पादित करने के लिए बटन। (पोस्टमैन या जैसे टूल का उपयोग करें curl प्रलेखित समापन बिंदुओं के विरुद्ध परीक्षण करने के लिए।)
packages/mewayz/ApiDocsGenerator/src/documentation/. जब नया एपीआई एंडपॉइंट शिप होता है, तो मेल खाने वाली JSON फ़ाइल को उसी रिलीज़ में जोड़ा या बढ़ाया जाता है।
उनका अपना ब्रांड नाम और आधार यूआरएल; प्रति किरायेदार को कोई अलग दस्तावेज़ बनाए रखने की आवश्यकता नहीं है।