OpenAPI / Swagger دستاویزات ویور

OpenAPI 3.0 اور Swagger 2.0 تفصیلات کو انٹرایکٹو API دستاویزات کے طور پر دیکھیں۔

OpenAPI / Swagger دستاویزات ویور کے بارے میں — تفصیلی رہنما

زمرہ: DevOps اور معیارات 100% براؤزر میں مقامی

OpenAPI Viewer ایک کلائنٹ سائیڈ ڈاکیومینٹیشن ریڈر ہے جو RESTful API کے معاہدوں (contracts) کا معائنہ کرنے کے لیے بنایا گیا ہے۔ یہ مقامی Swagger UI انسٹالیشنز یا کلاؤڈ انحصار کے بغیر JSON یا YAML میں Swagger 2.0 اور OpenAPI 3.0 / 3.1 کی وضاحتوں کو رینڈر کرتا ہے۔

یہ تمام اینڈ پوائنٹس کے لیے ایک صاف اور منظم سائیڈبار نیویگیشن پیش کرتا ہے، جس میں راستے (paths)، HTTP میتھڈز (GET، POST، PUT، DELETE)، ہیڈر پیرامیٹرز، کوئری سٹرنگز، ساختہ ریکوئسٹ باڈیز، HTTP ریسپانس کوڈز اور ڈیٹا سکیماز شامل ہیں۔

#openapi #swagger #api #docs #rest #yaml #json

اہم خصوصیات اور صلاحیتیں

  • JSON اور YAML میں Swagger 2.0 اور OpenAPI 3.0 / 3.1 وضاحتوں کی مکمل سپورٹ
  • انٹرایکٹو سائیڈبار جو زمرہ بند اینڈ پوائنٹس، HTTP میتھڈز اور اسٹیٹس کوڈز دکھاتا ہے
  • نیسٹڈ ڈیٹا ماڈلز اور پراپرٹی کی شرائط دکھانے کے لیے گہری `$ref` سکیما ریزولوشن
  • 100% کلائنٹ سائیڈ آف لائن پارسنگ جو ملکیتی انٹرپرائز API معاہدوں کو محفوظ رکھتی ہے

استعمال کرنے کا طریقہ

  1. 1

    اپنا `swagger.json` یا `openapi.yaml` ٹیکسٹ پیسٹ کریں، یا براہِ راست اسپیک فائل اپ لوڈ کریں۔

  2. 2

    انٹرایکٹو ویور میں رینڈر کردہ منظم API ڈاکیومینٹیشن کو براؤز کریں۔

  3. 3

    ریکوئسٹ ہیڈرز، ریکوئسٹ پے لوڈ سکیماز اور ریسپانس نمونوں کا جائزہ لینے کے لیے کسی بھی اینڈ پوائنٹ کو پھیلائیں۔

عام استعمال کی صورتیں

  • ← سرشار Swagger UI سرور قائم کیے بغیر بیک اینڈ API تعریفوں کا آڈٹ کرنا
  • ← غلط `$ref` پوائنٹرز کی جانچ کے لیے خود سے لکھی گئی OpenAPI وضاحتوں کی درستگی چیک کرنا
  • ← API انٹیگریشن کے دوران فرنٹ اینڈ انجینئرز کو درست سکیما حوالہ جات فراہم کرنا

متعلقہ ٹولز

اکثر پوچھے گئے سوالات اور رازداری

کیا یہ ٹول براہِ راست YAML وضاحتیں پڑھ سکتا ہے؟

جی ہاں۔ ایمبیڈڈ YAML پارسر براؤزر کے اندر ہی `.yaml` اور `.json` دونوں OpenAPI معاہدوں کی وضاحتوں کو پروسیس کرتا ہے۔

کیا میری ملکیتی API وضاحت کسی بیرونی سرور پر اپ لوڈ کی جاتی ہے؟

نہیں۔ تمام ڈاکیومنٹ پارسنگ اور سکیما رینڈرنگ مکمل طور پر آپ کے مقامی براؤزر کی میموری میں انجام پاتی ہے۔