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

Ultralytics OpenAPI एक उपकरण है जो OpenAPI विनिर्देशों (संस्करण 3.0 से 3.2.0) को पढ़ता है और एक ही अनुबंध से दो आउटपुट उत्पन्न करता है: इंटरैक्टिव API दस्तावेज़ और एक टाइप किया गया Python SDK। यह सभी मानक HTTP ऑपरेशन (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE) का समर्थन करता है। कॉन्फ़िगरेशन `openapi.config.json` फ़ाइल के माध्यम से किया जाता है, जहाँ आप स्रोत (स्थानीय फ़ाइल या URL), उत्पन्न पैकेज का नाम, API कुंजी पर्यावरण चर, दस्तावेज़ आधार पथ, और विभिन्न Python पैकेज मेटाडेटा (लेखक, वर्गीकरण, संस्करण, लाइसेंस, आदि) निर्दिष्ट करते हैं। उपकरण उपभोक्ता-स्वामित्व वाली Python स्रोत फ़ाइल शामिल करके वैकल्पिक CLI निर्माण का भी समर्थन करता है। मुख्य विशेषताओं में शामिल हैं: - सिंक्रोनस और एसिंक्रोनस Python क्लाइंट - टाइप किए गए संसाधन और TypedDict प्रतिक्रियाएँ - मल्टीपार्ट अपलोड समर्थन - अस्थायी विफलताओं के लिए स्वचालित पुनर्प्रयास - संरचित API त्रुटियाँ - API कुंजी हैंडलिंग जो दस्तावेज़ों के लिए ब्राउज़र मेमोरी में रहती है - नियतात्मक स्थैतिक दस्तावेज़ निर्माण - अनुकूलन योग्य ब्रांडिंग (लोगो, फ़ेविकॉन, ग्रेडिएंट टोकन) - कस्टम क्रेडेंशियल खोज के लिए वैकल्पिक प्रमाणीकरण प्रदाता मॉड्यूल उत्पन्न SDK डिफ़ॉल्ट रूप से AGPL-3.0 लाइसेंस के अंतर्गत होते हैं लेकिन इन्हें कॉन्फ़िगर किया जा सकता है। परियोजना Bun और uv के साथ विकसित की गई है, और इसमें विकास, परीक्षण और निर्माण के लिए कमांड शामिल हैं। भविष्य में TypeScript, Go और Java के लिए SDK की योजना बनाई गई है।