Swagger-UI और MSW का उपयोग बंद करें, इसके बजाय SDK इस्तेमाल करें

Swagger.json फ़ाइल से TypeScript SDK और mock simulator बनाने का टूल

यहाँ SDK (Software Development Kit) में निम्न क्षमताएँ शामिल हैं

• fetch functions का collection
• DTO structures
• Mockup Simulator

SDK को build करके इस्तेमाल करने पर front-end (client) डेवलपर के लिए swagger डॉक्युमेंट पढ़ते हुए fetch functions और DTO types को हाथ से दोबारा लिखने की तुलना में यह कहीं अधिक आसान और सुरक्षित हो जाता है। साथ ही, msw के जरिए backend server को mock करने का काम भी अपने-आप हो जाता है, जिससे उत्पादकता बढ़ती है।

[roxie]

अच्छा लेख है, और दिलचस्प approach के लिए धन्यवाद। यह मेरी व्यक्तिगत पसंद हो सकती है, लेकिन मुझे लगता है कि ऊपर के मुख्य भाग में इस तरह के उदाहरण होते तो अच्छा रहता कि "अगर यह कोड डालें, तो पहले यह होता था, और अब यह होगा।" मौजूदा मुख्य लेख पर अभी लगभग नज़र ही नहीं टिकती।

[kuber]

क्या TS ecosystem में docs देखकर संबंधित types और functions को मैन्युअली define करना आम बात है?

[hyeonss0417]

इसके संदर्भ में TypeScript types के आधार पर OpenAPI Spec को अपने-आप निकालने वाली Tspec नाम की एक लाइब्रेरी भी है, haha

https://github.com/ts-spec/tspec

[samchon]

TS में openapi-generator द्वारा बनाया गया कोड ज़्यादा उपयोगी नहीं है

[kunggom]

लगता है कि यह उस टूल के इस्तेमाल का तरीका है जिसे samchon ने खुद बनाया है, तो ऐसे में शायद इसे Show GN की तरफ जाना चाहिए।

खैर, swagger.json फ़ाइल का इस्तेमाल करके TypeScript client में auto-completion सक्षम करना एक अच्छा आइडिया लगता है। क्या यह NestJS के अलावा दूसरे backend stack में भी इस्तेमाल किया जा सकता है?

[samchon]

भाषा या framework की परवाह किए बिना, अगर आप OpenAPI v3.0 spec का swagger.json बिल्ड कर सकते हैं, तो बस वही काफ़ी है.

मैंने पहले भी यह ब्लॉग पोस्ट show GN टैग लगाकर डाली थी, लेकिन उस समय एडमिन ने कहा था कि show GN में केवल GitHub या project links ही पोस्ट किए जाते हैं, और उन्होंने इसे सामान्य पोस्ट में स्थानांतरित कर दिया था.