🎁 🧔 ➖ स्व-प्रलेखित माइक्रोसर्विसेस (अरंगबीडीबी + स्वैगर) 👩🏾‍🍳 🧒🏼 🎾

अप-टू-डेट microservices के लिए प्रलेखन को बनाए रखने के लिए अभी भी विकास में अत्यंत अनुशासन की आवश्यकता है, और महान श्रम लागत की। उदाहरण के लिए, ग्राफकॉक प्रलेखन बनाने के लिए एक बहुत ही उचित दृष्टिकोण प्रदान करता है, जहां प्रलेखन कार्यक्रम कोड के साथ अटूट रूप से जुड़ा हुआ है और यह प्रलेखन और दस्तावेज सेवाओं के 100% अनुपालन की गारंटी देता है। हालाँकि, REST-API के आदी रहे डेवलपर्स के लिए GraphQL का असामान्य दृष्टिकोण, अभी भी व्यावहारिक अनुप्रयोग विकास में इस तकनीक को बढ़ावा देना मुश्किल बनाता है। यहां आप SOAP को याद कर सकते हैं, जिसने लंबे समय तक प्रलेखन और सेवाओं की अनुरूपता की समस्या को हल किया है, लेकिन अति-जटिलता के कारण यह डेवलपर्स की व्यापक जनता के बीच जड़ नहीं ले पाया।

मैं विकासशील माइक्रोसेर्वर्स के लिए ऐसी तकनीकों का पता लगाना चाहूंगा, जिन्होंने "पारंपरिक" रीस्ट-एपीआई माइक्रोसर्विसेस को विकसित करते समय प्रोग्राम कोड की समान स्व-दस्तावेजीकरण प्रदान किया हो। और वह, जैसा कि यह निकला, पहले से मौजूद है।

हम उन अभिनेताओं और कलाकारों को परिभाषित करते हैं जो हमारे छोटे उदाहरण में शामिल होंगे।

ArangoDB एक हाइब्रिड, दस्तावेज़ + ग्राफ़-उन्मुख डेटाबेस है।

युपीडी। इस डेटाबेस के साथ अधिक विस्तृत परिचित एक और निराशा का कारण था। जैसा कि यह निकला, डेटाबेस एक गैर-सीमित सीमा से अधिक होने के बाद, जो कि मुक्त रैम द्वारा सीमित है, डेटाबेस धीमा करना शुरू कर देता है - यह सर्वर के साथ बस बंद हो जाता है। इसी समय, डरपोक धारणाएं व्यक्त की गईं कि नए भंडारण इंजनों के लिए संक्रमण बेहतर काम करेगा, जिनकी अभी तक पुष्टि नहीं हुई है।

फॉक्सएक्स एक माइक्रोसेवे फ्रेमवर्क है जिसे अरंगबीडीबी डेटाबेस में बनाया गया है। यह एक जावास्क्रिप्ट इंजन पर चलता है, जो (नोडज के विपरीत) एक साथ एक समान संख्या में समानांतर थ्रेड्स (एक दूसरे को ब्लॉक नहीं कर रहा है) में निष्पादित किया जा सकता है, जिसके परिणामस्वरूप वादे / कैंच और async / इंतजार की कोई आवश्यकता नहीं है। मोंगोडब के विपरीत, जिसमें यह सर्वर प्रक्रियाओं का दुरुपयोग करने के लिए अनुशंसित नहीं है, और रिलेशनल डेटाबेस जिसमें संग्रहीत कार्यविधियाँ भी सावधानी से उपयोग की जाती हैं और निश्चित रूप से REST-API के माध्यम से क्लाइंट (ब्राउज़र, मोबाइल एप्लिकेशन इत्यादि) के साथ बातचीत नहीं करती हैं, यह एक माइक्रोसॉफ़्ट फ्रेमवर्क है। फॉक्सएक्स को विशेष रूप से माइक्रोसर्विसेज के विकास के लिए डिज़ाइन किया गया था जो ग्राहकों के साथ http प्रोटोकॉल के साथ सीधे संवाद करते हैं।

स्वैगर एक खुला स्रोत सॉफ्टवेयर वातावरण है जो उपकरणों के एक बड़े पारिस्थितिकी तंत्र द्वारा समर्थित है जो डेवलपर्स को विकसित करने, बनाने, दस्तावेज़ बनाने और Restful वेब सेवाओं का उपभोग करने में मदद करता है। हालांकि अधिकांश उपयोगकर्ता स्वैगर UI के साथ स्वैगर की पहचान करते हैं, स्वैगर टूलकिट में स्वचालित प्रलेखन, कोड पीढ़ी और परीक्षण परीक्षण पीढ़ी के लिए समर्थन शामिल है।

तथ्य यह है कि स्वैगर में कोड पीढ़ी के लिए समर्थन शामिल है, वह उस स्थिति के विपरीत है जिसे हम प्राप्त करना चाहते हैं - जब कोड प्रलेखन पीढ़ी का समर्थन करता है। ArangoDB + लोमड़ी हमें क्या प्रदान करता है बस विपरीत विकल्प शामिल है। जब एक माइक्रोसॉर्फ़ कोड स्वैगर के लिए एक सर्किट उत्पन्न करता है। हालाँकि, अब आप यह सत्यापित कर सकते हैं कि आपने न्यूनतम कार्य किया है।

आगे की क्रिया करने के लिए आपके पास ArangoDB स्थापित होना चाहिए।

हम व्यवस्थापक पैनल में जाते हैं और एक नया माइक्रोसैस सर्विस बनाने के लिए आइटम का चयन करते हैं-> सेवा जोड़ें-> नया।
हम खोले गए फॉर्म में आवश्यक फॉर्म भरते हैं। "दस्तावेज़ संग्रह" फ़ील्ड में, दस्तावेज़ संग्रह का नाम जोड़ें, जो तब बनाया जाएगा जब माइक्रोसेवा तैनात किया गया हो। उदाहरण के लिए, बिल्लियों।
हम इंस्टॉल बटन पर क्लिक करते हैं, url फ़ील्ड में दर्ज करें, जिस पर माइक्रोसेवर माउंट किया जाएगा।

"दस्तावेज़ संग्रह" फ़ील्ड (अनुभाग 2 देखें) से प्रत्येक संग्रह के लिए, एक माइक्रोफ़ोन स्थापित करते समय, मार्गों का निर्माण किया जाएगा जो POST, GET, PUT और DELETE विधियों का उपयोग करके CRUD संचालन को लागू करते हैं। हालाँकि, यह केवल उन विधियों का एक मसौदा है, जिन्हें आप बदल सकते हैं, हटा सकते हैं, नए जोड़ सकते हैं। हमने एक संग्रह तब चुना था, जब हम एक माइक्रोसर्विस (बिल्लियों) का निर्माण कर रहे थे, हालाँकि हमने ऐसा नहीं किया होगा, लेकिन बाद में मैन्युअल रूप से सब कुछ जोड़ा।

अब, हमारे बिल्लियों के संग्रह में CRUD के संचालन के लिए मार्ग हैं, और हम API टैब (सेवा -> [माइक्रोसेवर नाम] -> एपीआई) का चयन करके डेटाबेस व्यवस्थापक पैनल से इन मार्गों को कॉल करना शुरू कर सकते हैं। इस टैब में परिचित स्वैगर इंटरफ़ेस है। एक बाहरी मार्ग पर स्वैगर इंटरफ़ेस को प्रकाशित करना भी संभव है, न केवल व्यवस्थापक पैनल के माध्यम से सुलभ है, बल्कि एक नियमित URL के रूप में।

यदि हम POST {"नाम": "टॉम"} विधि का उपयोग करके बिल्लियों के संग्रह में दस्तावेज़ को जोड़ने का प्रयास करते हैं, तो हमें एक त्रुटि के साथ स्थिति मिलती है। क्योंकि नाम फ़ील्ड जिसे हमने अभी तक परिभाषित नहीं किया है। इसलिए, हम ArangoDB व्यवस्थापक पैनल के साथ काम करना जारी रखेंगे।

4. अधिक सुविधाजनक विकास के लिए, ArangoDB डेवलपमेंट मोड प्रदान करता है, जो सेटिंग्स टैब पर सक्षम है (सेवाएँ -> [माइक्रोसॉर्स्ट नाम] -> सेटिंग-सेट डेवलपमेंट)

अब आप विश्व सेवा के कोड को बदल सकते हैं और तुरंत परिणाम देख सकते हैं (अतिरिक्त तैनाती के बिना)। वह निर्देशिका जहाँ माइक्रोसॉर्फ़ प्रोग्राम कोड स्थित है, वह जानकारी टैब पर व्यवस्थापक पैनल में पाई जा सकती है (सेवाएँ -> [माइक्रोसेवर नाम] -> जानकारी)।

आइए देखें कि POST मार्ग की परिभाषा क्या दिखती है।

'use strict'; const dd = require('dedent'); const joi = require('joi'); const httpError = require('http-errors'); const status = require('statuses'); const errors = require('@arangodb').errors; const createRouter = require('@arangodb/foxx/router'); const Cat = require('../models/cat'); const cats = module.context.collection('cats'); const keySchema = joi.string().required() .description('The key of the cat'); const ARANGO_NOT_FOUND = errors.ERROR_ARANGO_DOCUMENT_NOT_FOUND.code; const ARANGO_DUPLICATE = errors.ERROR_ARANGO_UNIQUE_CONSTRAINT_VIOLATED.code; const ARANGO_CONFLICT = errors.ERROR_ARANGO_CONFLICT.code; const HTTP_NOT_FOUND = status('not found'); const HTTP_CONFLICT = status('conflict'); const router = createRouter(); module.exports = router; router.tag('cat'); router.post(function (req, res) { const cat = req.body; let meta; try { meta = cats.save(cat); } catch (e) { if (e.isArangoError && e.errorNum === ARANGO_DUPLICATE) { throw httpError(HTTP_CONFLICT, e.message); } throw e; } Object.assign(cat, meta); res.status(201); res.set('location', req.makeAbsolute( req.reverse('detail', {key: cat._key}) )); res.send(cat); }, 'create') .body(Cat, 'The cat to create.') .response(201, Cat, 'The created cat.') .error(HTTP_CONFLICT, 'The cat already exists.') .summary('Create a new cat') .description(dd` Creates a new cat from the request body and returns the saved document. `);

सत्यापन और प्रलेखन दोनों एक वस्तु स्कीमा के उपयोग पर आधारित हैं। हम नाम फ़ील्ड को जोड़कर उसमें छोटे परिवर्तन करेंगे:

 'use strict'; const _ = require('lodash'); const joi = require('joi'); module.exports = { schema: { // Describe the attributes with joi here _key: joi.string(), name: joi.string().description('cat`s name'), //    }, forClient(obj) { // Implement outgoing transformations here obj = _.omit(obj, ['_id', '_rev', '_oldRev']); return obj; }, fromClient(obj) { // Implement incoming transformations here return obj; } };

एपीआई बुकमार्क पर जाकर, आप यह सुनिश्चित कर सकते हैं कि सर्किट बदल गया है और अब बिल्लियों के संग्रह में नाम फ़ील्ड के साथ ऑब्जेक्ट को जोड़ा जा सकता है।

apapacy@gmail.com
12 नवंबर 2018।

स्व-प्रलेखित माइक्रोसर्विसेस (अरंगबीडीबी + स्वैगर)

More articles: