स्वैगर माइग्रेशन लेक्चर

Jul 17, 2024

स्वैगर माइग्रेशन लेक्चर

इंट्रोडक्शन

  • स्प्रिंग फॉक्स का उपयोग डॉक्यूमेंटेशन जनरेट करने में किया गया था।
  • माइग्रेशन की जरूरत आई, समस्याओं के समाधान को ढूंढ़ा और फिर नए तरीके से डॉक्यूमेंटेशन जनरेट किया।

माइग्रेशन की समस्याएं

  • स्प्रिंग फॉक्स का उपयोग करते हुए सपोर्ट की कमी हुई।
  • स्प्रिंग बूट 3 से स्प्रिंग फॉक्स का सपोर्ट नहीं था।
  • स्टैक ओवरफ्लो पर इस संबंध में एक प्रश्न मिला जिससे पता चला कि वर्तमान में स्प्रिंग फॉक्स स्प्रिंग बूट 3 का सपोर्ट नहीं कर रहा है।

समाधान

  • स्प्रिंग फॉक्स को छोड़कर स्प्रिंगडॉक का उपयोग करने का सुझाव।
  • माइग्रेशन गाइड का उपयोग करने की सलाह दी गई।

चरणबद्ध माइग्रेशन प्रोसेस

  1. स्प्रिंग फॉक्स और स्वैगर की डिपेंडेंसी को हटाना:

    • स्प्रिंग फॉक्स और स्वैगर 2 डिपेंडेंसी को प्रोजेक्ट से हटाएं।
    • नई स्प्रिंग डॉक ओपन स्टार्टर वेब डिपेंडेंसी जोड़ें।
  2. अनोटेशन परिवर्तन:

    • स्वैगर 2 की अनोटेशन को स्वैगर 3 की अनोटेशन से बदलना।
    • विभिन्न अनोटेशन जैसे APIOperation, ApiResponse, ApiParam आदि को अपडेट करना।
  3. कस्टमाइज़ेशन और प्रॉपर्टीज बदलना:

    • पब्लिक क्लास ओपन एपी कॉन्फ़िगरेशन बनाना।
    • application.properties में बदलाव करना।
    • @OpenAPIDefinition जोड़कर बेसिक सेटअप करना, जैसे title, description, version, आदि।
  4. सिक्योरिटी:

    • v3/api-docs को पब्लिक एक्सेसिबल करना।

निष्कर्ष

  • प्रोजेक्ट सक्सेसफुली माइग्रेट हुआ स्प्रिंगडॉक पर।
  • स्वैगर डॉक्यूमेंटेशन अब स्प्रिंग बूट 3 के साथ काम कर रही है।
  • कोई प्रश्न या समस्याएं होने पर स्टैक ओवरफ्लो या माइग्रेशन गाइड की ओर देखा जा सकता है।

नेक्स्ट स्टेप्स

  • अगले अपडेट तक स्प्रिंग फॉक्स को ना उपयोग करना।
  • डॉक्यूमेंटेशन को बेहतर करने के लिए नेक्स्ट वीडियो का प्रदर्शन।

नोट्स

  • वीडियो और प्रीमियम कोर्स का उल्लेख: अधिक जानकारी के लिए वेबसाइट लिंक पर जाएं।