منصوبے کے بارے میں
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 کلیدی ہینڈلنگ جو دستاویزات کے لیے براؤزر میموری میں رہتی ہے
- تعییناتی جامد دستاویزات کی تعمیر
- حسب ضرورت برانڈنگ (لوگو، فیویکون، گریڈینٹ ٹوکنز)
- حسب ضرورت اسناد کی تلاش کے لیے اختیاری auth فراہم کنندہ ماڈیول
تیار کردہ SDKs بطور ڈیفالٹ AGPL-3.0 لائسنس کے تحت ہیں لیکن انہیں کنفیگر کیا جا سکتا ہے۔ پروجیکٹ Bun اور uv کے ساتھ تیار کیا گیا ہے، اور اس میں ڈیولپمنٹ، ٹیسٹنگ، اور جنریشن کے لیے کمانڈز شامل ہیں۔ مستقبل میں TypeScript، Go، اور Java کے لیے SDKs کی منصوبہ بندی کی گئی ہے۔
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.