ToolRobinلاگ اِن کے بغیر فوراً استعمال کریں

OpenAPI مطابقت چیکر

مقامی طور پر دو OpenAPI 3.x تصریحات کا موازنہ کریں اور آپریشن اور فیلڈ پاتھ کے ذریعہ ممکنہ طور پر API معاہدے کی تبدیلیوں کا جائزہ لیں۔

اصل اور نظر ثانی شدہ OpenAPI 3.0، 3.1 یا 3.2 فائلوں کو چسپاں کریں یا منتخب کریں۔ شدت اور متاثرہ فیلڈ کا راستہ چیک کریں، پھر جائزہ کے لیے مارک ڈاؤن یا JSON رپورٹ ڈاؤن لوڈ کریں۔

ریلیز سے پہلے دو OpenAPI فائلوں کا موازنہ کریں۔ وضاحتیں اس براؤزر میں رہتی ہیں۔

نیچے JSON یا YAML چسپاں کریں، یا فائل منتخب کریں۔
نیچے JSON یا YAML چسپاں کریں، یا فائل منتخب کریں۔

ہر فائل: 2 MB تک اور 1,000 آپریشنز۔ OpenAPI 3.0، 3.1 اور 3.2 کو سپورٹ کرتا ہے۔

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

API جاری کرنے سے پہلے OpenAPI تبدیلیوں کا جائزہ لیں۔

مقامی طور پر دو OpenAPI 3.x تصریحات کا موازنہ کریں اور آپریشن اور فیلڈ پاتھ کے ذریعہ ممکنہ طور پر API معاہدے کی تبدیلیوں کا جائزہ لیں۔

استعمال کے مراحل

  1. اصل ان پٹ یہاں دیں: اصل تفصیلات / نظر ثانی شدہ تفصیلات۔
  2. چلائیں: مطابقت کی جانچ کریں۔۔ نقل، ڈاؤن لوڈ یا دوسرے استعمال سے پہلے نتیجہ دیکھیں۔
  3. اصل اور نظر ثانی شدہ OpenAPI 3.0، 3.1 یا 3.2 فائلوں کو چسپاں کریں یا منتخب کریں۔ شدت اور متاثرہ فیلڈ کا راستہ چیک کریں، پھر جائزہ کے لیے مارک ڈاؤن یا JSON رپورٹ ڈاؤن لوڈ کریں۔

ترتیبات کا انتخاب

اختیارکیا بدلتا ہے
اصل تفصیلاتتصریح فائل کے اندر حوالہ جات کی پیروی کی جاتی ہے۔ خارجی فائل یا یو آر ایل حوالہ جات حاصل نہیں کیے جاتے ہیں اور جائزے کے نتائج کے طور پر ظاہر ہوتے ہیں۔ تکراری اسکیموں کا موازنہ ان کی پہلی صورت میں کیا جاتا ہے اور جائزہ کے لیے نشان زد کیا جاتا ہے۔
مطابقت کی جانچ کریں۔چیکر آپریشنز، پیرامیٹرز، ریکوئسٹ باڈیز، رسپانس کوڈز اور میڈیا کی اقسام کے علاوہ عام اسکیما تبدیلیوں جیسے کہ ہٹائی گئی پراپرٹیز، نئی مطلوبہ ریکوسٹ پراپرٹیز، ٹائپ تبدیلیاں اور اینوم ویلیوز کا موازنہ کرتا ہے۔ نتائج میں متاثرہ آپریشن اور فیلڈ پاتھ شامل ہیں۔

مثال اور متوقع نتیجہ

اگر نظر ثانی شدہ GET /users/{id} جواب ایک اختیاری `ای میل` فیلڈ کی ضرورت بناتا ہے، تو رپورٹ تبدیل شدہ جوابی معاہدے کو جھنڈا دیتی ہے۔ مقامی `$ref` حوالہ جات کی پیروی کی جاتی ہے۔ بیرونی حوالہ جات اور پیچیدہ سکیما کمپوزیشن کو دستی جائزہ کے لیے طلب کیا جاتا ہے۔ یہ مکمل تفصیلات کی توثیق کرنے والا یا چل رہے API کا ٹیسٹ نہیں ہے۔

اگر کام نہ کرے

  • نتیجہ ایک مستحکم معاہدہ کا جائزہ ہے، نہ کہ ایک مکمل OpenAPI موافقت کی توثیق کرنے والا، رن ٹائم API ٹیسٹ یا سیکیورٹی آڈٹ۔ سرور کے رویے، اجازت کی منطق اور پیچیدہ اسکیما کی ساخت کے لیے دستی جائزے کی ضرورت پڑ سکتی ہے۔ رپورٹ میں کہا گیا ہے کہ کن حوالوں یا تکراری ڈھانچے کی مکمل جانچ نہیں کی گئی۔
  • پارسنگ ناکام ہو تو API نتائج سے پہلے JSON یا YAML کی ساخت دیکھیں۔ ضروری مقامی حوالے اسی دستاویز میں رکھیں۔ بیرونی حوالے اور غیر معاون ساختیں دستی جائزہ چاہتی ہیں؛ ٹول انہیں حاصل نہیں کرتا اور زندہ سرور نہیں آزماتا۔

کن تبدیلیوں کی جانچ پڑتال کی جاتی ہے؟

چیکر آپریشنز، پیرامیٹرز، ریکوئسٹ باڈیز، رسپانس کوڈز اور میڈیا کی اقسام کے علاوہ عام اسکیما تبدیلیوں جیسے کہ ہٹائی گئی پراپرٹیز، نئی مطلوبہ ریکوسٹ پراپرٹیز، ٹائپ تبدیلیاں اور اینوم ویلیوز کا موازنہ کرتا ہے۔ نتائج میں متاثرہ آپریشن اور فیلڈ پاتھ شامل ہیں۔

حوالہ جات کیسے سنبھالے جاتے ہیں؟

تصریح فائل کے اندر حوالہ جات کی پیروی کی جاتی ہے۔ خارجی فائل یا یو آر ایل حوالہ جات حاصل نہیں کیے جاتے ہیں اور جائزے کے نتائج کے طور پر ظاہر ہوتے ہیں۔ تکراری اسکیموں کا موازنہ ان کی پہلی صورت میں کیا جاتا ہے اور جائزہ کے لیے نشان زد کیا جاتا ہے۔

اس چیک سے باہر کیا ہے؟

نتیجہ ایک مستحکم معاہدہ کا جائزہ ہے، نہ کہ ایک مکمل OpenAPI موافقت کی توثیق کرنے والا، رن ٹائم API ٹیسٹ یا سیکیورٹی آڈٹ۔ سرور کے رویے، اجازت کی منطق اور پیچیدہ اسکیما کی ساخت کے لیے دستی جائزے کی ضرورت پڑ سکتی ہے۔ رپورٹ میں کہا گیا ہے کہ کن حوالوں یا تکراری ڈھانچے کی مکمل جانچ نہیں کی گئی۔

آپ کو بھی ضرورت پڑسکتی ہے۔