OpenAPI / Swagger व्यूअर

OpenAPI (Swagger 2.0/3.0) YAML/JSON विनिर्देशों का पूर्वावलोकन और इंटरएक्टिव परीक्षण करें।

OpenAPI / Swagger व्यूअर के बारे में — विस्तृत गाइड

श्रेणी: DevOps और मानक 100% ब्राउज़र में लोकल

OpenAPI Viewer RESTful API कॉन्ट्रैक्ट्स का निरीक्षण करने के लिए एक क्लाइंट-साइड डॉक्यूमेंटेशन रीडर है। यह स्थानीय Swagger UI इंस्टॉलेशन या क्लाउड निर्भरताओं की आवश्यकता के बिना JSON या YAML में Swagger 2.0 और OpenAPI 3.0 / 3.1 विनिर्देशों को रेंडर करता है।

यह सभी एंडपॉइंट्स के लिए साफ़ और समूहीकृत साइडबार नेविगेशन प्रदान करता है, जिसमें पाथ, 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 विनिर्देश बाहरी सर्वरों पर अपलोड किया जाता है?

नहीं। सभी दस्तावेज़ पार्सिंग और स्कीमा रेंडरिंग पूरी तरह से आपके स्थानीय ब्राउज़र मेमोरी के भीतर निष्पादित होते हैं।