OpenAPI ट्रिमर के साथ अपनी OpenAPI फ़ाइलों को सरल बनाना

बड़ी ओपनएपीआई फ़ाइलों को प्रबंधित करना एक परेशानी हो सकती है, खासकर जब आपको विशिष्ट कार्यों के लिए एपीआई के केवल एक छोटे हिस्से की आवश्यकता होती है। यहीं पर ओपनएपीआई ट्रिमर काम आता है। यह एक हल्का उपकरण है जिसे आपकी ओपनएपीआई फ़ाइलों को ट्रिम करके केवल उन एंडपॉइंट और डेटा ट्रांसफर ऑब्जेक्ट (डीटीओ) को शामिल करने के लिए डिज़ाइन किया गया है जिनकी आप परवाह करते हैं।

यह कैसे काम करता है?

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

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

यह आदेश होगा:

• -i openapi.yaml: इनपुट के रूप में अपनी मौजूदा OpenAPI YAML फ़ाइल का उपयोग करें।
• -p /v1/quotes,/v1/users: केवल /v1/quotes और /v1/users से शुरू होने वाले समापन बिंदु रखें।
• -ec CompanyConfigDto,UpdateCompanyConfigDto: विशिष्ट घटकों को बाहर करें, इस मामले में, कंपनीConfigDto, और UpdateCompanyConfigDto।

छंटाई की गई एपीआई परिभाषा को openapi-trimmer.yaml के रूप में सहेजा जाएगा।

मान्यकरण

अपनी ट्रिम की गई ओपनएपीआई फ़ाइल की अखंडता सुनिश्चित करने के लिए, इसे इसके साथ सत्यापित करें:

swagger-cli validate ./openapi-trimmer.yaml

यह चरण आपके द्वारा ट्रिम की गई एपीआई फ़ाइल को तैनात करने या साझा करने से पहले किसी भी समस्या को पकड़ने में मदद करता है।

इंस्टालेशन

आप सीधे PyPi से OpenAPI ट्रिमर इंस्टॉल कर सकते हैं:

pip install openapi-trimmer

अधिक विवरण और नवीनतम अपडेट के लिए, OpenAPI ट्रिमर PyPi पृष्ठ पर जाएं।

GitHub रिपॉजिटरी: GitHub पर OpenAPI ट्रिमर।

कमांड-लाइन विकल्प

ओपनएपीआई ट्रिमर अपने संचालन को अनुकूलित करने के लिए कई विकल्प प्रदान करता है:

• -h, --help: सहायता जानकारी दिखाएं।
• -v, --version: संस्करण संख्या प्रदर्शित करें।
• -i इनपुट, --इनपुट इनपुट: इनपुट YAML फ़ाइल निर्दिष्ट करें (आवश्यक)।
• -ओ आउटपुट, --आउटपुट आउटपुट: आउटपुट फ़ाइल नाम को परिभाषित करें (वैकल्पिक; इनपुट फ़ाइल में '-ट्रिम्ड' जोड़ने पर डिफ़ॉल्ट)।
• -p उपसर्ग, --उपसर्ग उपसर्ग: आउटपुट में बनाए रखने के लिए पथों की सूची बनाएं (अल्पविराम से अलग)।
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS: बाहर करने के लिए घटकों की सूची बनाएं (अल्पविराम से अलग)।

निष्कर्ष

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