ओपनएपीआई संगतता परीक्षक

स्थानीय रूप से दो ओपनएपीआई 3.एक्स विनिर्देशों की तुलना करें और ऑपरेशन और फ़ील्ड पथ द्वारा संभावित रूप से तोड़ने वाले एपीआई अनुबंध परिवर्तनों की समीक्षा करें।

मूल और संशोधित ओपनएपीआई 3.0, 3.1 या 3.2 फ़ाइलें चिपकाएँ या चुनें। गंभीरता और प्रभावित फ़ील्ड पथ की जाँच करें, फिर समीक्षा के लिए मार्कडाउन या JSON रिपोर्ट डाउनलोड करें।

रिलीज से पहले दो ओपनएपीआई फाइलों की तुलना करें। विशिष्टताएँ इस ब्राउज़र में रहती हैं.

नीचे JSON या YAML चिपकाएँ, या एक फ़ाइल चुनें।
नीचे JSON या YAML चिपकाएँ, या एक फ़ाइल चुनें।

प्रत्येक फ़ाइल: 2 एमबी तक और 1,000 ऑपरेशन। ओपनएपीआई 3.0, 3.1 और 3.2 को सपोर्ट करता है।

कैसे उपयोग करें

एपीआई जारी करने से पहले ओपनएपीआई परिवर्तनों की समीक्षा करें

स्थानीय रूप से दो ओपनएपीआई 3.एक्स विनिर्देशों की तुलना करें और ऑपरेशन और फ़ील्ड पथ द्वारा संभावित रूप से तोड़ने वाले एपीआई अनुबंध परिवर्तनों की समीक्षा करें।

इस्तेमाल करने के चरण

  1. मूल इनपुट यहाँ दें: मूल विशिष्टता / संशोधित विशिष्टता।
  2. चुनें: अनुकूलता की जांच करें। कॉपी, डाउनलोड या दूसरे उपयोग से पहले परिणाम जाँचें।
  3. मूल और संशोधित ओपनएपीआई 3.0, 3.1 या 3.2 फ़ाइलें चिपकाएँ या चुनें। गंभीरता और प्रभावित फ़ील्ड पथ की जाँच करें, फिर समीक्षा के लिए मार्कडाउन या JSON रिपोर्ट डाउनलोड करें।

विकल्प कैसे चुनें

विकल्पक्या बदलता है
मूल विशिष्टताएक विनिर्देश फ़ाइल के भीतर संदर्भों का पालन किया जाता है। बाहरी फ़ाइल या यूआरएल संदर्भ नहीं लाए जाते हैं और समीक्षा निष्कर्ष के रूप में दिखाई देते हैं। पुनरावर्ती स्कीमा की तुलना उनकी पहली घटना पर की जाती है और समीक्षा के लिए चिह्नित की जाती है।
अनुकूलता की जांच करेंचेकर संचालन, मापदंडों, अनुरोध निकायों, प्रतिक्रिया कोड और मीडिया प्रकारों की तुलना करता है, साथ ही सामान्य स्कीमा परिवर्तन जैसे हटाए गए गुण, नए आवश्यक अनुरोध गुण, प्रकार परिवर्तन और एनम मान की तुलना करता है। निष्कर्षों में प्रभावित ऑपरेशन और फ़ील्ड पथ शामिल हैं।

उदाहरण और अपेक्षित परिणाम

यदि संशोधित GET /users/{id} प्रतिक्रिया एक वैकल्पिक `ईमेल` फ़ील्ड को आवश्यक बनाती है, तो रिपोर्ट बदले हुए प्रतिक्रिया अनुबंध को चिह्नित करती है। स्थानीय `$ref` संदर्भों का पालन किया जाता है; बाहरी संदर्भों और जटिल स्कीमा संरचना को मैन्युअल समीक्षा के लिए बुलाया जाता है। यह पूर्ण विनिर्देश सत्यापनकर्ता या चल रहे एपीआई का परीक्षण नहीं है।

अगर काम नहीं कर रहा हो

  • परिणाम एक स्थिर अनुबंध समीक्षा है, न कि पूर्ण ओपनएपीआई अनुरूपता सत्यापनकर्ता, रनटाइम एपीआई परीक्षण या सुरक्षा ऑडिट। सर्वर व्यवहार, प्राधिकरण तर्क और जटिल स्कीमा संरचना के लिए मैन्युअल समीक्षा की आवश्यकता हो सकती है। रिपोर्ट में कहा गया है कि किन संदर्भों या पुनरावर्ती संरचनाओं की पूरी तरह से जाँच नहीं की गई।
  • पार्सिंग विफल हो तो API परिणाम देखने से पहले JSON या YAML सिंटैक्स जाँचें। आवश्यक स्थानीय संदर्भ उसी दस्तावेज़ में रखें। बाहरी संदर्भ और असमर्थित स्कीमा की हाथ से समीक्षा करें; टूल उन्हें डाउनलोड नहीं करता और लाइव सर्वर नहीं जाँचता।

किन परिवर्तनों की जाँच की जाती है?

चेकर संचालन, मापदंडों, अनुरोध निकायों, प्रतिक्रिया कोड और मीडिया प्रकारों की तुलना करता है, साथ ही सामान्य स्कीमा परिवर्तन जैसे हटाए गए गुण, नए आवश्यक अनुरोध गुण, प्रकार परिवर्तन और एनम मान की तुलना करता है। निष्कर्षों में प्रभावित ऑपरेशन और फ़ील्ड पथ शामिल हैं।

संदर्भों को कैसे संभाला जाता है?

एक विनिर्देश फ़ाइल के भीतर संदर्भों का पालन किया जाता है। बाहरी फ़ाइल या यूआरएल संदर्भ नहीं लाए जाते हैं और समीक्षा निष्कर्ष के रूप में दिखाई देते हैं। पुनरावर्ती स्कीमा की तुलना उनकी पहली घटना पर की जाती है और समीक्षा के लिए चिह्नित की जाती है।

इस चेक के बाहर क्या है?

परिणाम एक स्थिर अनुबंध समीक्षा है, न कि पूर्ण ओपनएपीआई अनुरूपता सत्यापनकर्ता, रनटाइम एपीआई परीक्षण या सुरक्षा ऑडिट। सर्वर व्यवहार, प्राधिकरण तर्क और जटिल स्कीमा संरचना के लिए मैन्युअल समीक्षा की आवश्यकता हो सकती है। रिपोर्ट में कहा गया है कि किन संदर्भों या पुनरावर्ती संरचनाओं की पूरी तरह से जाँच नहीं की गई।