इस प्रोजेक्ट के बारे में

स्वैगर कोडजेन OpenAPI या स्वैगर API विवरणों को जनरेटेड क्लाइंट लाइब्रेरी, सर्वर स्टब्स, API दस्तावेज़ीकरण और सहायक आर्टिफैक्ट में बदल देता है। 2.x और 3.x लाइनों को स्वतंत्र रूप से बनाए रखा जाता है और वे अलग-अलग Maven ग्रुप आईडी का उपयोग करते हैं; OpenAPI 3.0.x समर्थन केवल 3.x में उपलब्ध है। README 3.0.71 को स्पेक 1.0 से 3.0 के लिए वर्तमान 3.x स्थिर रिलीज़ और 2.4.46 को स्पेक 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 एक ऑनलाइन स्वैगर वैलिडेटर और स्थानीय सत्यापन के लिए Spectral की ओर इशारा करता है। एक सुरक्षा नोट चेतावनी देता है कि अविश्वसनीय स्रोतों से स्पेसिफिकेशन को जनरेशन से पहले समीक्षा की जानी चाहिए क्योंकि कोड इंजेक्शन हो सकता है। प्रोजेक्ट के टेम्पलेट रिपॉजिटरी लाइसेंस के अंतर्गत आते हैं, लेकिन जनरेटेड कोड AS IS, उपयोगकर्ता के स्वामित्व में और मूल प्रोजेक्ट लाइसेंस के अधीन नहीं होने का इरादा है।