swaggerशुरुआत स्वैगर से हुई


टिप्पणियों

यह खंड स्वैगर क्या है का एक सिंहावलोकन प्रदान करता है, और क्यों एक डेवलपर इसका उपयोग करना चाह सकता है।

इसमें स्वैगर के भीतर किसी भी बड़े विषय का उल्लेख होना चाहिए, और संबंधित विषयों के लिए लिंक करना चाहिए। चूंकि स्वैगर के लिए दस्तावेज़ीकरण नया है, इसलिए आपको उन संबंधित विषयों के प्रारंभिक संस्करण बनाने की आवश्यकता हो सकती है।

परिचय - स्थापना - सेटअप (Node.js में विकास)

परिचय:

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

लेखन विनिर्देशों:

विनिर्देशों को JSON या YAML में लिखा जा सकता है। और इसलिए हम तदनुसार swagger.json या swagger.yaml फ़ाइल बनाते हैं। फ़ाइल बनाने के लिए ऑनलाइन संपादक का उपयोग किया जा सकता है। यहाँ विनिर्देशों के लिए वाक्यविन्यास का वर्णन करने वाला एक लिंक है: http://swagger.io/specification/

स्वैगर का उपयोग करने के तरीके:

  1. एपीआई-प्रथम दृष्टिकोण (ऊपर नीचे दृष्टिकोण): स्वैगर संपादक का उपयोग करें → स्वैगर परिभाषाएं लिखें → एपीआई उत्पन्न करने के लिए स्वैगर-कोडगेन और स्वैगर-यूआई का उपयोग करें
  2. सेवा पहला दृष्टिकोण (बॉटम अप एप्रोच): स्वैगर एनोटेशन का उपयोग करके JAX-RS संसाधन क्लासेस विकसित करें → स्वैगर-परिभाषाएँ बनाने के लिए स्वैगर-कोर का उपयोग करें → स्वैगर-कोडजेन और स्वैगर-यूआई का उपयोग करके एपीआई और डॉक्यूमेंटेशन उत्पन्न करने के लिए। ऊपर स्वैगर मावेन प्लगइन के दौरान मावेन बिल्ड के दौरान किया जा सकता है।

स्थापना और सेटअप

इस खंड में, हम स्वैगर स्थापित करेंगे, स्वैगर UI को सेटअप करेंगे और इसका उपयोग करते हुए सर्वर साइड और क्लाइंट एसडीके उत्पन्न करेंगे। नोड पैकेज मैनेजर का उपयोग करके स्वैगर स्थापित करने के लिए निम्नलिखित कमांड निष्पादित करें:

npm install -g swagger

'-G' ध्वज का उपयोग सुनिश्चित करेगा कि मॉड्यूल विश्व स्तर पर स्थापित है। अगला, हम निम्नलिखित कमांड का उपयोग करके एक प्रोजेक्ट बनाएंगे:

swagger project create <project-name>

यह उपयोगकर्ता को REST API को विकसित करने के लिए एक रूपरेखा का चयन करने के लिए कहेगा। उसी के लिए एक्सप्रेस का चयन किया जा सकता है। यह निम्नलिखित मदों और उनमें से प्रत्येक में एक README.md फ़ाइल के साथ परियोजना निर्देशिका बनाएगा:

  • एपीआई /
    • नियंत्रक /
    • सहायकों /
    • mocks /
    • अकड़ /
  • config /
  • परीक्षा/
    • एपीआई /
      • नियंत्रक /
      • सहायकों
  • app.js
  • package.json

सर्वर मूल रूप से अब तैयार है और प्रोजेक्ट रूट में निष्पादित होने के लिए इस कमांड का उपयोग शुरू किया जा सकता है:

swagger project start

यदि होस्ट सर्वर को localhost रूप में सेट किया गया है और app.js नंबर में फ़ाइल में पोर्ट नंबर को संशोधित नहीं किया गया है, तो सर्वर शुरू हो जाता है: http://localhost:10010 अब स्वैगर UI का उपयोग हमारे REST API को और विकसित करने के लिए किया जा सकता है। इसका उपयोग करके एक नए टर्मिनल में शुरू किया जा सकता है:

swagger project edit

यह एक बेतरतीब ढंग से उत्पन्न बंदरगाह पर एक ब्राउज़र टैब में स्वैगर संपादक को खोल देगा। एक नमूना हैलो GET अनुरोध पहले से ही swagger.yaml फ़ाइल में देखा जा सकता है। इस फाइल में कोई और बदलाव करने से सर्वर अपने आप रिस्टार्ट हो जाएगा।

पथ अनुभाग में, x-swagger-router-controller लिए उपयोग किया जाने वाला मान नियंत्रक फ़ोल्डर में जावास्क्रिप्ट फ़ाइल नाम होना चाहिए। एक नमूने के रूप में, hello_world.js को नियंत्रक निर्देशिका में उपस्थित होना चाहिए। इसके अलावा, operationId पैरामीटर के लिए मान उपरोक्त जावास्क्रिप्ट फ़ाइल में फ़ंक्शन नाम का प्रतिनिधित्व करता है। यह वह जगह है जहाँ व्यावसायिक तर्क लिखा जाना चाहिए। इस प्रकार, हमारा स्वैगर सेटअप पूरा हो गया है और इसका उपयोग हमारे एपीआई को और विकसित करने के लिए किया जा सकता है।