क्या आप कभी भी एनोटेशन के आधार पर अपने एक्सप्रेस एपीआई के लिए एक स्वैगर प्रलेखन चाहते हैं? मेरे पास है। और दुर्भाग्य से मैन्युअल रूप से एक swagger.json फ़ाइल बनाने के लिए बिना इसे करने का कोई तरीका नहीं मिला। इस तरह मेरी इच्छा सरल थी: मैं कई समापन बिंदुओं के साथ एक स्वच्छ एक्सप्रेस ऐप रखना चाहता हूं और मैं समापन बिंदु कार्यान्वयन के लिए स्वैगर प्रलेखन रखना चाहता हूं, एक अलग फाइल में नहीं।

शायद मुझे कुछ Google कौशल की कमी है, लेकिन मैंने फैसला किया कि इस तरह के टूल को बनाना मेरे लिए बहुत आसान होगा। और यहाँ यह है: mgr-swagger-express

शुरुआत हो रही है

यहां उदाहरण टाइपस्क्रिप्ट में लिखा जाएगा, लेकिन जावास्क्रिप्ट प्रोजेक्ट में भी ऐसा ही किया जा सकता है।
तो एक शास्त्रीय एक्सप्रेस एप्लिकेशन की कल्पना करें:

यहां हमारे पास एक संसाधन "बुक" और कुछ बुनियादी CRUD समापन बिंदु हैं। सवाल यह है कि "आप इस एपीआई में एक कूल स्वैगर डॉक्यूमेंट को कैसे जोड़ेंगे?" मैं वास्तव में एनोटेशन का उपयोग करना चाहता था ताकि प्रत्येक समापन बिंदु के दस्तावेज़ को समापन बिंदु के पास ही रखा जा सके।

यह वही है जो आप मिग-स्वैगर-एक्सप्रेस के साथ कर पाएंगे:
index.ts :

BookService.ts :

एक बॉट अधिक कोड है, लेकिन अब हमारे पास समापन बिंदु के पास सभी स्वैगर प्रलेखन हैं।
आइए देखें कि यहां क्या हो रहा है:

• इंडेक्स फ़ाइल में, हम हमेशा की तरह एक्सप्रेस ऐप बनाते हैं। इसके अलावा हमें सभी मिडलवेर्स (बॉडीपेयर सबसे महत्वपूर्ण है) को इनिशियलाइज़ करना है।
• इसके बाद हम SET_EXPRESS_APP को विश्व स्तर पर ऐप ऑब्जेक्ट सेट करने के लिए कहते हैं। इस तरह मिग-स्वैगर-एक्सप्रेस हैंडलर को एंडपॉइंट्स में संलग्न करने में सक्षम होगा
• इसके बाद ही हम एनोटेशन के साथ सेवा का आयात कर सकते हैं। यह एक वर्ग होने की जरूरत नहीं है, यह सिर्फ कार्य हो सकता है।
• तब हम अपनी सेवा का एक उदाहरण बनाते हैं (या कक्षाओं का उपयोग नहीं करने के मामले में एक init फ़ंक्शन को कॉल करते हैं)
• और हम प्रोजेक्ट में मौजूद सभी एनोटेशन के आधार पर स्वैगर कॉन्फिगरेशन उत्पन्न करते हैं और स्वैगर-उई-एक्सप्रेस पैकेज का उपयोग करके इसे अपने ऐप में संलग्न करते हैं।

सेवा के अंदर, कई चीजें चल रही हैं, लेकिन चलो उनमें से कुछ पर ही रोक दें। बाकी सब कुछ आप आसानी से मिग-स्वैगर-एक्सप्रेस रेपो में पा सकते हैं:

• कंस्ट्रक्टर में हम addSwaggerDefinition फ़ंक्शन कहते हैं। यह एक दिए गए नाम के साथ एक स्वैगर मॉडल को पंजीकृत करता है। हमारे मामले में हम BookDefinition को एक बुक नाम के तहत परिभाषित करते हैं ताकि इसे बाद में #/definitions/Book द्वारा संदर्भित किया जा सके
• सभी हैंडलर @GET @POST @PUT @DELETE कमांड से एनोटेट किए गए हैं। वे सभी तर्क में एक प्रकार की वस्तु ले रहे हैं SwaggerEndpoint :
  

   path: string; auth?: string; description?: string; tags?: string[]; parameters?: SwaggerURLParameter[]; query?: SwaggerQueryParameter; body?: SwaggerBodyParameter; success?: SwaggerSuccessResponse; 

  
  

  यह मूल रूप से शास्त्रीय स्वैगर एंडपॉइंट डेफिनेशन ऑब्जेक्ट है, विशेष क्षेत्र के अलावा कुछ खास नहीं है, लेकिन मैं इसे भविष्य में वापस आऊंगा

  
  सभी हैंडलर में निम्नलिखित हस्ताक्षर होने चाहिए:
  

   (args: object, context: Context) => Promise<any> 

  
  

  आर्ग्स ऑब्जेक्ट में आपके समापन बिंदु पर रखे गए सभी पैरामीटर शामिल हैं। यह URL पैरामीटर हो सकता है (जैसे कि हमारे उदाहरण में book_id ), क्वेरी पैरामीटर या यहां तक ​​कि शरीर का मान भी।

  
  
  

  संदर्भ ऑब्जेक्ट का उपयोग प्रमाणीकरण और सुरक्षा को संभालने के लिए किया जाता है, लेकिन फिर से, इसके बारे में बाद में।

  
  

  निष्कर्ष

  
  

  अब हमारे पास एक सरल CRUD एक्सप्रेस एपीआई है जो स्वैगर और एक सुंदर स्वैगर यूआई के साथ एनोटेट किया गया है, जहां सभी स्वैगर परिभाषाएं एंडपॉइंट कार्यान्वयन के पास स्थित हैं। हमेशा की तरह - किसी भी प्रतिक्रिया के लिए हमेशा खुश! ️