منصوبے کے بارے میں

Swagger Codegen OpenAPI یا Swagger API وضاحتوں کو تیار شدہ کلائنٹ لائبریریوں، سرور اسٹبس، API دستاویزات اور معاون آرٹیفیکٹس میں تبدیل کرتا ہے۔ 2.x اور 3.x لائنیں آزادانہ طور پر برقرار رکھی جاتی ہیں اور مختلف Maven گروپ IDs استعمال کرتی ہیں؛ OpenAPI 3.0.x سپورٹ صرف 3.x میں دستیاب ہے۔ README میں 3.0.71 کو specs 1.0 سے 3.0 کے لیے موجودہ 3.x مستحکم ریلیز کے طور پر اور 2.4.46 کو specs 1.0 سے 2.0 کے لیے موجودہ 2.x مستحکم ریلیز کے طور پر درج کیا گیا ہے۔ سپورٹ شدہ آؤٹ پٹس میں Java، Python، JavaScript/TypeScript، Go، C#، PHP، Ruby، Swift، Kotlin، Rust اور بہت سی دیگر زبانوں کے لیے API کلائنٹس؛ Spring، JAX-RS، ASP.NET Core، Go، Flask، Node.js، Rails اور Scala فریم ورکس سمیت سرور اسٹبس؛ اور HTML، ڈائنامک HTML اور Confluence Wiki دستاویزات شامل ہیں۔ یہ Apache2 کنفیگریشن اور JMeter سے متعلقہ آؤٹ پٹ بھی تیار کر سکتا ہے۔ مرکزی انٹرفیس ایک Java CLI ہے۔ ایک عام کمانڈ ان پٹ اسپیکیفکیشن، ہدف زبان یا فریم ورک اور آؤٹ پٹ ڈائریکٹری استعمال کرتی ہے۔ CLI عمومی جنریشن مدد اور زبان کے مخصوص کنفیگریشن مدد فراہم کرتا ہے، جبکہ کنفیگریشن فائلیں، حسب ضرورت ٹیمپلیٹس، ٹائپ میپنگز، امپورٹ میپنگز اور انتخابی جنریشن تیار شدہ آؤٹ پٹ کو موزوں بنانے کی اجازت دیتی ہیں۔ ڈائنامک HTML آؤٹ پٹ شامل کردہ Node.js مثال کے ذریعے پیش کیا جا سکتا ہے، جبکہ اسٹیٹک HTML آؤٹ پٹ ایک سادہ اسٹینڈ اکیلے HTML فائل تیار کرتا ہے۔ یہ پروجیکٹ Maven کے ساتھ بلڈنگ، Docker استعمال کرنے اور Maven، Gradle اور GitHub پر مبنی ورک فلو میں جنریشن کو ضم کرنے کی دستاویزات فراہم کرتا ہے۔ آن لائن جنریٹرز کا بھی حوالہ دیا گیا ہے ان صارفین کے لیے جو اپنی مثال نہیں چلانا چاہتے۔ اسپیکیفکیشن کی توثیق کے لیے، README آن لائن Swagger validator اور مقامی توثیق کے لیے Spectral کی طرف اشارہ کرتا ہے۔ ایک حفاظتی نوٹ خبردار کرتا ہے کہ غیر معتبر ذرائع سے حاصل کردہ اسپیکیفکیشنز کا جنریشن سے پہلے جائزہ لیا جانا چاہیے کیونکہ کوڈ انجیکشن ہو سکتا ہے۔ پروجیکٹ کے ٹیمپلیٹس ریپوزٹری لائسنس کے تحت آتے ہیں، لیکن تیار کردہ کوڈ AS IS ہوتا ہے، صارف کی ملکیت ہوتا ہے اور والدین پروجیکٹ لائسنس کے تابع نہیں ہوتا۔