OpenAPI स्पेक व्यूअर
एंडपॉइंट ब्राउज़िंग, स्कीमा निरीक्षण और cURL जनरेशन के साथ OpenAPI/Swagger स्पेक्स को पार्स और एक्सप्लोर करें। मुफ़्त, तेज़ और पूरी तरह आपके ब्राउज़र में काम करता है, बिना साइन-अप के।
अपडेट किया गया
OpenAPI Spec Viewer
Parse and explore OpenAPI/Swagger specifications with endpoint browsing, schema inspection, and cURL generation.
OpenAPI Specification
अक्सर पूछे जाने वाले प्रश्न
OpenAPI स्पेक व्यूअर क्या है?
OpenAPI स्पेक व्यूअर एक मुफ़्त ऑनलाइन टूल है जो endpoint ब्राउज़िंग, स्कीमा निरीक्षण और cURL जनरेशन के साथ OpenAPI/Swagger स्पेक को पार्स और एक्सप्लोर करता है। यह पूरी तरह आपके ब्राउज़र में चलता है, बिना किसी इंस्टॉलेशन या साइन-अप के।
कौन-कौन से संस्करण?
JSON और YAML दोनों में OpenAPI 3.x और Swagger 2.0। फ़ॉर्मेट स्वतः पहचाना जाता है।
एक्सपोर्ट?
इनपुट फ़ॉर्मेट चाहे जो भी हो, JSON या YAML के रूप में एक्सपोर्ट करें। पूरी स्पेक को क्लिपबोर्ड पर कॉपी करें।
cURL जनरेशन?
किसी भी endpoint पर क्लिक करें, Copy as cURL का उपयोग करें। सर्वर URL, मेथड, हेडर और बॉडी प्लेसहोल्डर के साथ कमांड बनाता है।
क्या OpenAPI स्पेक व्यूअर उपयोग करने के लिए मुफ़्त है?
हाँ, OpenAPI स्पेक व्यूअर 100% मुफ़्त है, बिना किसी पंजीकरण, छिपे शुल्क या उपयोग सीमा के। सारी प्रोसेसिंग आपके ब्राउज़र में स्थानीय रूप से होती है, जिससे पूर्ण गोपनीयता सुनिश्चित होती है।
क्या इस टूल के साथ मेरा डेटा सुरक्षित है?
बिल्कुल। OpenAPI स्पेक व्यूअर सब कुछ आपके ब्राउज़र में क्लाइंट-साइड पर प्रोसेस करता है। कोई भी डेटा किसी सर्वर पर अपलोड या संग्रहीत नहीं किया जाता। आपकी सामग्री हर समय आपके डिवाइस पर निजी रहती है।
क्या OpenAPI स्पेक व्यूअर मोबाइल डिवाइस पर काम करता है?
हाँ, OpenAPI स्पेक व्यूअर पूरी तरह रिस्पॉन्सिव है और स्मार्टफोन तथा टैबलेट पर काम करता है। आप इसे किसी भी आधुनिक वेब ब्राउज़र वाले डिवाइस पर उपयोग कर सकते हैं, किसी ऐप डाउनलोड की आवश्यकता नहीं।
क्या इस टूल का उपयोग करने के लिए मुझे खाता बनाना होगा?
किसी खाते या पंजीकरण की आवश्यकता नहीं है। बस अपने ब्राउज़र में OpenAPI स्पेक व्यूअर खोलें और तुरंत उपयोग शुरू करें। कोई साइन-अप बाधा या उपयोग प्रतिबंध नहीं है।
यह कौन-कौन सी प्रोग्रामिंग भाषाएँ या फ़ॉर्मेट समर्थित करता है?
OpenAPI स्पेक व्यूअर लोकप्रिय फ़ॉर्मेट और भाषाओं की एक विस्तृत श्रृंखला का समर्थन करता है। समर्थित विकल्पों की पूरी सूची के लिए टूल इंटरफ़ेस देखें।
मैं OpenAPI स्पेक व्यूअर का उपयोग कैसे करूँ?
बस दिए गए फ़ील्ड में अपना इनपुट दर्ज करें, अपनी पसंद के अनुसार सेटिंग्स समायोजित करें, और टूल उसे तुरंत प्रोसेस कर देगा। फिर आप परिणाम को क्लिपबोर्ड पर कॉपी कर सकते हैं या डाउनलोड कर सकते हैं।
OpenAPI और Swagger में क्या अंतर है?
Swagger इस स्पेसिफिकेशन का मूल नाम था, और वर्ज़न 2.0 को आज भी आमतौर पर "Swagger" ही कहा जाता है। 2016 में इस फॉर्मेट को OpenAPI Initiative को सौंप दिया गया और इसका नाम OpenAPI कर दिया गया, इसलिए वर्ज़न 3.x को सही तरीके से OpenAPI कहा जाता है। आज "Swagger" आमतौर पर टूलिंग को दर्शाता है — Swagger UI, Swagger Editor, Codegen — जबकि "OpenAPI" खुद स्पेसिफिकेशन डॉक्यूमेंट को दर्शाता है। दोनों एक ही परिवार के हैं: दोनों किसी REST API के एंडपॉइंट, पैरामीटर, रिक्वेस्ट बॉडी, रिस्पॉन्स, और डेटा मॉडल को एक ही JSON या YAML फाइल में बताते हैं। 3.x में मुख्य संरचनात्मक बदलाव यह है कि बॉडी पैरामीटर और रिस्पॉन्स मॉडल एक पुन: उपयोग योग्य "components/schemas" सेक्शन में चले गए, और "definitions" का नाम बदलकर "schemas" हो गया। यह व्यूअर Swagger 2.0 और OpenAPI 3.x दोनों को पढ़ता है, यह पहचानते हुए कि आपका डॉक्यूमेंट कौन सा वर्ज़न इस्तेमाल करता है, और उसे उसी तरह रेंडर करता है, इसलिए इसे एक्सप्लोर करने के लिए कोई भी फॉर्मेट पेस्ट करें।
क्या मैं किसी OpenAPI स्पेक को YAML से JSON में बदल सकता हूँ?
हाँ। चूँकि व्यूअर आपकी स्पेसिफिकेशन को मेमोरी में एक स्ट्रक्चर्ड ऑब्जेक्ट में पार्स करता है, यह उसी डॉक्यूमेंट को चाहे आपने किसी भी फॉर्मेट में पेस्ट किया हो, किसी भी सीरियलाइज़ेशन फॉर्मेट में वापस दे सकता है। कोई YAML स्पेक डालें और सही फॉर्मेट में JSON वर्ज़न डाउनलोड करने के लिए Export JSON का इस्तेमाल करें, या JSON पेस्ट करें और इंडेंटेड YAML वर्ज़न पाने के लिए Export YAML इस्तेमाल करें — API का विवरण, एंडपॉइंट, और स्कीमा बिलकुल वही रहते हैं, सिर्फ सिंटैक्स बदलता है। यह तब काम आता है जब कोई बिल्ड टूल, मॉक सर्वर, या क्लाइंट जनरेटर एक फॉर्मेट चाहता है लेकिन आपकी टीम ने स्पेक दूसरे फॉर्मेट में लिखा हो। आप पूरे कन्वर्ट किए गए डॉक्यूमेंट को सीधे अपने क्लिपबोर्ड पर भी कॉपी कर सकते हैं। यह सब कुछ आपके ब्राउज़र में ही स्थानीय रूप से चलता है, इसलिए आंतरिक या अप्रकाशित स्पेक भी कभी आपकी मशीन से बाहर नहीं जाता। अपनी फाइल पेस्ट करें और अपनी ज़रूरत का एक्सपोर्ट फॉर्मेट चुनें।
व्यूअर यह कैसे पहचानता है कि मेरा स्पेक JSON है या YAML?
फॉर्मेट पहले non-whitespace कैरेक्टर से अपने आप पहचान लिया जाता है। अगर आपका पेस्ट किया गया टेक्स्ट किसी opening brace से शुरू होता है, तो उसे JSON मानकर उसी हिसाब से पार्स किया जाता है; बाकी सब कुछ YAML के रूप में पार्स किया जाता है, क्योंकि किसी स्पेक के लिए वैध JSON हमेशा एक ऑब्जेक्ट से शुरू होता है। पार्सिंग के बाद, व्यूअर यह पक्का करने के लिए "openapi" या "swagger" फील्ड जाँचता है कि डॉक्यूमेंट वाकई एक असली स्पेसिफिकेशन है, न कि कोई मनमाना डेटा। अगर पार्सिंग विफल हो जाती है — कोई गलत टैब, मिसिंग कोट, खराब इंडेंटेशन — तो यह खाली स्क्रीन दिखाने के बजाय सटीक एरर मैसेज दिखाता है, ताकि आप समस्या को जल्दी ढूँढ़कर ठीक कर सकें। इसका मतलब है कि आपको कभी यह बताने की ज़रूरत नहीं कि आप कौन सा फॉर्मेट इस्तेमाल कर रहे हैं या पहले कमेंट हटाने की ज़रूरत नहीं। बस अपनी स्पेक फाइल की कच्ची सामग्री पेस्ट करें और बाकी काम व्यूअर खुद कर लेता है, फिर API को आपके लिए रेंडर कर देता है।
व्यूअर स्कीमा के बीच $ref रेफरेंस को कैसे हैंडल करता है?
OpenAPI स्पेक दोहराव से बचने के लिए मॉडल को एक बार "components/schemas" के अंतर्गत परिभाषित करते हैं और बाकी जगहों पर "$ref" रेफरेंस के ज़रिए उनकी ओर इशारा करते हैं — कोई रिस्पॉन्स किसी Pet स्कीमा को रेफर कर सकता है जो खुद एक Category और Tags के ऐरे को रेफर करती है। Schemas टैब में, व्यूअर हर मॉडल को एक विस्तार-योग्य ट्री के रूप में रेंडर करता है और उन "$ref" पॉइंटर्स को उस मॉडल तक रिज़ॉल्व कर देता है जिसे वे टारगेट करते हैं, ताकि आप कच्चे टेक्स्ट में डेफिनिशन ढूँढ़ने के लिए स्क्रॉल करने के बजाय नेस्टेड ऑब्जेक्ट और ऐरे के ज़रिए क्लिक करके आगे बढ़ सकें। हर प्रॉपर्टी अपना टाइप, फॉर्मेट, वह ज़रूरी है या नहीं, और कोई भी enum विकल्प दिखाती है, जिससे हर मॉडल का असली स्वरूप एक नज़र में साफ हो जाता है। इससे आपको फाइल के एक हिस्से को दूसरे हिस्से से हाथ से मिलाकर यह समझने की ज़रूरत नहीं पड़ती कि डेटा कैसे आपस में जुड़ता है। अपनी स्पेक पार्स करने के बाद Schemas टैब खोलें और मॉडल के संबंधों को विज़ुअली देखें।
HTTP मेथड और स्टेटस कोड को अलग-अलग रंगों में क्यों दिखाया जाता है?
रंग-कोडिंग एक पठनीयता सहायक है जो आपको हर लेबल पढ़े बिना एक बड़े API को स्कैन करने देता है। हर ऑपरेशन में एक मेथड बैज होता है — GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS — जो अपने वर्ब के हिसाब से रंगीन होता है, ताकि टैग के अनुसार समूहबद्ध लंबी एंडपॉइंट सूची को देखते समय सुरक्षित रीड, राइट और डिलीट ऑपरेशन से अलग दिखें। किसी खुले हुए एंडपॉइंट के भीतर, रिस्पॉन्स स्टेटस कोड उनकी क्लास के हिसाब से रंगीन होते हैं: 2xx सफलता, 3xx रीडायरेक्ट, 4xx क्लाइंट एरर, और 5xx सर्वर एरर — हर एक एक नज़र में अलग पहचाना जा सकता है, ताकि आप तुरंत देख सकें कि कोई ऑपरेशन कौन-कौन से रिस्पॉन्स लौटा सकता है। डेप्रिकेटेड ऑपरेशन को अलग से फ्लैग किया जाता है ताकि आप ऐसे एंडपॉइंट पर निर्भर न बनें जो जल्द हटाया जाने वाला है। साथ में, ये संकेत एक घने स्पेक को कुछ ऐसा बना देते हैं जिसे आप जल्दी परख सकते हैं। रंग योजना को क्रियान्वित होते देखने के लिए कोई स्पेक पेस्ट करें, या बिल्ट-इन Petstore सैंपल लोड करें।
संबंधित टूल
मुफ़्त JSON Schema जनरेटर
अपने JSON डेटा से स्वचालित रूप से JSON Schema बनाएं। मुफ़्त, तेज़ और पूरी तरह आपके ब्राउज़र में काम करता है, बिना साइन-अप के।
मुफ़्त API टेस्टर ऑनलाइन
GET, POST, PUT, DELETE अनुरोधों के साथ REST API का परीक्षण करें। मुफ़्त, तेज़ और पूरी तरह आपके ब्राउज़र में काम करता है, बिना साइन-अप के।
HTTP रिक्वेस्ट / cURL बिल्डर
HTTP रिक्वेस्ट दृश्य रूप से बनाएं और cURL, fetch, axios, Node http, Python requests, PHP curl, Go net/http और HTTPie में एक्सपोर्ट करें।
GraphQL क्वेरी बिल्डर
डायनामिक फ़ील्ड ट्री, वेरिएबल, फ़्रैगमेंट और लाइव आउटपुट के साथ GraphQL क्वेरी, म्यूटेशन और सब्सक्रिप्शन को विज़ुअल रूप से बनाएँ।
OpenAPI Spec Viewer के बारे में
OpenAPI Spec Viewer किसी भी कच्ची API स्पेसिफिकेशन को एक पढ़ने-योग्य, ब्राउज़ करने योग्य रेफरेंस में बदल देता है। कोई भी OpenAPI 3.x या Swagger 2.0 डॉक्यूमेंट — चाहे JSON में हो या YAML में — पेस्ट करें, और यह व्यूअर उसे पार्स करके API का सारांश दिखाता है, हर एंडपॉइंट को उसके टैग के हिसाब से सूचीबद्ध करता है, और आपको पैरामीटर, रिक्वेस्ट बॉडी, रिस्पॉन्स स्कीमा, और मॉडल डेफिनिशन तक गहराई से जाने देता है। यह बैकएंड और फ्रंटएंड डेवलपर्स, QA इंजीनियर्स, और टेक्निकल राइटर्स के लिए बनाया गया है जिन्हें कोई स्पेक फाइल मिलती है और जिन्हें बिना कोई होस्टेड डॉक्यूमेंटेशन सर्वर खड़ा किए API को जल्दी समझना होता है।
फॉर्मेट अपने आप पहचान लिया जाता है: जो इनपुट { से शुरू होता है उसे JSON माना जाता है, बाकी सब कुछ YAML के रूप में पार्स किया जाता है। इसके बाद व्यूअर यह पक्का करने के लिए openapi या swagger फील्ड जाँचता है कि यह वाकई एक असली स्पेसिफिकेशन है, और अगर पार्सिंग विफल होती है तो यह खाली स्क्रीन दिखाने के बजाय सटीक एरर दिखाता है। अगर आपके पास तैयार स्पेक नहीं है, तो बिल्ट-इन Petstore सैंपल एक पूरा OpenAPI 3.0 डॉक्यूमेंट लोड कर देता है ताकि आप देख सकें कि सब कुछ कैसे रेंडर होता है।
व्यूअर आपको क्या दिखाता है
एक बार स्पेक पार्स हो जाए, तो एक API Information पैनल टाइटल, वर्ज़न, स्पेक वर्ज़न (OpenAPI 3.x या Swagger 2.0), डिस्क्रिप्शन, और कोई भी घोषित सर्वर सामने लाता है। एक स्टैटिस्टिक्स रो कुल एंडपॉइंट गिनती है, उन्हें HTTP मेथड के हिसाब से बाँटता है, और बताता है कि कितने पुन: उपयोग योग्य (reusable) स्कीमा परिभाषित हैं। यहाँ से, दो टैब पूरी जानकारी को व्यवस्थित करते हैं:
- Endpoints — हर ऑपरेशन उसके टैग के अंतर्गत समूहबद्ध, रंग-कोडेड मेथड बैज (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) के साथ। किसी भी एंडपॉइंट पर क्लिक करके उसका सारांश, ऑपरेशन ID, पैरामीटर (उनकी लोकेशन — path, query, header — टाइप, और वे ज़रूरी हैं या नहीं), रिक्वेस्ट बॉडी, और रिस्पॉन्स की पूरी सूची खोली जा सकती है। रिस्पॉन्स स्टेटस कोड को उनकी क्लास के हिसाब से रंग-कोडेड किया गया है, ताकि 2xx, 3xx, 4xx, और 5xx एक नज़र में अलग पहचाने जा सकें, और डेप्रिकेटेड ऑपरेशन को अलग से फ्लैग किया जाता है।
- Schemas —
components/schemasसेक्शन के मॉडल, एक विस्तार-योग्य ट्री के रूप में रेंडर किए जाते हैं। हर प्रॉपर्टी अपना टाइप, फॉर्मेट, रिक्वायर्ड मार्कर, और enum विकल्प दिखाती है, और$refरेफरेंस उस मॉडल तक रिज़ॉल्व कर दिए जाते हैं जिसकी वे ओर इशारा करते हैं, ताकि आप बिना कच्चे टेक्स्ट में स्क्रॉल किए नेस्टेड ऑब्जेक्ट और ऐरे स्ट्रक्चर को आसानी से फॉलो कर सकें।
किसी भी एंडपॉइंट से cURL कमांड बनाना
किसी एंडपॉइंट को पढ़ना एक बात है; उसे कॉल करना बिलकुल अलग बात। हर खुले हुए एंडपॉइंट में एक Copy as cURL बटन होता है जो स्पेक के पहले सर्वर URL, सही HTTP मेथड, रिक्वेस्ट पाथ, हेडर पैरामीटर को -H फ्लैग के रूप में, और — रिक्वेस्ट बॉडी वाले ऑपरेशन के लिए — कंटेंट टाइप के साथ एक -d '{}' प्लेसहोल्डर इस्तेमाल करके एक चलने-योग्य कमांड तैयार करता है, जिसे आप खुद भर सकते हैं। इससे आपको डॉक्यूमेंटेशन से हाथ से रिक्वेस्ट लिखने के बजाय टर्मिनल या किसी HTTP क्लाइंट में सीधे पेस्ट करने लायक एक शुरुआती बिंदु मिल जाता है।
स्पेक को एक्सपोर्ट और कन्वर्ट करना
चूँकि व्यूअर डॉक्यूमेंट को एक स्ट्रक्चर्ड ऑब्जेक्ट में पार्स करता है, यह उसे आपके ज़रूरत के किसी भी फॉर्मेट में वापस दे सकता है। पूरी स्पेसिफिकेशन को JSON या YAML के रूप में एक्सपोर्ट करें, चाहे वह किसी भी फॉर्मेट में आई हो, या पूरे स्पेक को अपने क्लिपबोर्ड पर कॉपी कर लें। इससे OpenAPI Spec Viewer एक रीडर होने के साथ-साथ API डेफिनिशन के लिए एक झटपट YAML-to-JSON (या JSON-to-YAML) कन्वर्टर भी बन जाता है।
प्राइवेसी और यह कैसे काम करता है
सब कुछ आपके ब्राउज़र के भीतर होता है। स्पेक को क्लाइंट-साइड JavaScript का इस्तेमाल करते हुए आपकी अपनी डिवाइस पर ही पार्स, जाँचा, और कन्वर्ट किया जाता है — कुछ भी सर्वर पर अपलोड नहीं होता, कोई अकाउंट बनाने की ज़रूरत नहीं है, और कोई उपयोग सीमा नहीं है। यह तब मायने रखता है जब API डेफिनिशन आंतरिक (internal) या अभी अप्रकाशित हो: एंडपॉइंट, ऑथ स्कीम, और डेटा मॉडल बताने वाला एक निजी स्पेक आपकी मशीन पर ही रहता है। पेज लोड होने के बाद यह ऑफलाइन भी काम करता रहता है, और बड़ी स्पेसिफिकेशन को किसी रिमोट क्यू की बजाय आपके अपने हार्डवेयर की रफ़्तार पर हैंडल किया जाता है।