ओपनएपीआई स्पेसिफिकेशन एक मानक प्रारूप है जो HTTP API का वर्णन करता है ताकि इसे न केवल लोग बल्कि उपकरण भी पढ़ सकें। एक ही दस्तावेज़ में प्रत्येक पथ और विधि, उनके द्वारा लिए जाने वाले पैरामीटर, JSON स्कीमा के रूप में अनुरोध और प्रतिक्रिया निकाय, स्थिति कोड और प्रमाणीकरण योजनाएँ सूचीबद्ध होती हैं। इसका मूल नाम स्वैगर था; ओपनएपीआई 3.1 इसका वर्तमान प्रमुख संस्करण है।
एक ही दस्तावेज़ से, उपकरण इंटरैक्टिव संदर्भ दस्तावेज़, कई भाषाओं में क्लाइंट SDK, सर्वर स्टब्स, मॉक सर्वर और कॉन्ट्रैक्ट टेस्ट तैयार करते हैं। उसी फ़ाइल की तुलना चल रहे API से की जा सकती है, जिससे विवरण और कार्यान्वयन में कोई अंतर नहीं रह जाता और बिल्ड विफल हो जाता है।
एक ओपनएपीआई फ़ाइल यह साबित करती है कि एपीआई वर्णित अनुसार व्यवहार करती है। यह एक दावा है, परीक्षण नहीं: कोई भी चीज़ हैंडलर को विनिर्देश में उल्लिखित न होने वाले फ़ील्ड या सूचीबद्ध न होने वाली स्थिति को लौटाने से नहीं रोकती। इसका महत्व वास्तविक प्रतिक्रियाओं के साथ इसकी जाँच से निर्धारित होता है, जो कि अनुबंध परीक्षण का कार्य है।
यहां मौजूद प्रत्येक एपीआई अपना खुद का ओपनएपीआई 3.1 दस्तावेज़ /docs/{api-id}/openapi.json पर प्रकाशित करता है, और /openapi.json संपूर्ण कैटलॉग को कवर करता है; ये दोनों दस्तावेज़ पृष्ठों द्वारा प्रस्तुत समान परिभाषाओं से उत्पन्न होते हैं।
सभी शब्द · परीक्षण तकनीकें · सभी 39 मॉक REST API
आखरी अपडेट