প্রকল্প সম্পর্কে

Swagger Codegen OpenAPI বা Swagger API বর্ণনাকে জেনারেটেড ক্লায়েন্ট লাইব্রেরি, সার্ভার স্টাব, API ডকুমেন্টেশন এবং সহায়ক আর্টিফ্যাক্টে রূপান্তর করে। 2.x এবং 3.x লাইনগুলি স্বাধীনভাবে রক্ষণাবেক্ষণ করা হয় এবং ভিন্ন Maven গ্রুপ আইডি ব্যবহার করে; OpenAPI 3.0.x সমর্থন শুধুমাত্র 3.x এ উপলব্ধ। README 3.0.71 কে বর্তমান 3.x স্থিতিশীল রিলিজ হিসেবে তালিকাভুক্ত করে যা স্পেক 1.0 থেকে 3.0 পর্যন্ত, এবং 2.4.46 কে বর্তমান 2.x স্থিতিশীল রিলিজ হিসেবে যা স্পেক 1.0 থেকে 2.0 পর্যন্ত। সমর্থিত আউটপুটগুলির মধ্যে রয়েছে 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 ভ্যালিডেটর এবং স্থানীয় ভ্যালিডেশনের জন্য Spectral-এর দিকে নির্দেশ করে। একটি নিরাপত্তা নোটিশ সতর্ক করে যে অবিশ্বস্ত উৎস থেকে স্পেসিফিকেশন জেনারেশনের আগে পর্যালোচনা করা উচিত কারণ কোড ইনজেকশন ঘটতে পারে। প্রকল্পের টেমপ্লেটগুলি রিপোজিটরি লাইসেন্সের অধীনে কভার করা হয়, কিন্তু জেনারেটেড কোড AS IS, ব্যবহারকারীর মালিকানাধীন এবং মূল প্রকল্প লাইসেন্সের অধীন নয় বলে উদ্দেশ্য।