OpenAPI / Swagger दर्शक

OpenAPI v3 आणि Swagger दस्तऐवज थेट रेंडर करा आणि परस्परसंवादीपणे तपासा.

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` स्कीमा रिझोल्यूशन
  • प्रोप्रायटरी एंटरप्राइज API कॉन्ट्रॅक्ट्स सुरक्षित ठेवणारे 100% क्लायंट-साइड ऑफलाइन पार्सिंग

कसे वापरावे

  1. 1

    तुमचा `swagger.json` किंवा `openapi.yaml` मजकूर पेस्ट करा, किंवा थेट स्पेक फाईल अपलोड करा.

  2. 2

    इंटरएक्टिव्ह व्ह्यूअरमध्ये रेंडर केलेले स्ट्रक्चर्ड API डॉक्युमेंटेशन ब्राउझ करा.

  3. 3

    रिक्वेस्ट हेडर्स, रिक्वेस्ट पेलोड स्कीमा आणि रिस्पॉन्स सॅम्पल्स तपासण्यासाठी कोणताही एंडपॉइंट विस्तृत करा.

सामान्य वापर प्रकरणे

  • → स्वतंत्र Swagger UI सर्व्हर सुरू न करता बॅकएंड API व्याख्यांचे ऑडिट करणे
  • → अवैध `$ref` पॉइंटर्ससाठी हाताने लिहिलेल्या OpenAPI स्पेसिफिकेशन्सची सॅनिटरी तपासणी (sanity-checking) करणे
  • → API इंटिग्रेशन दरम्यान फ्रंटएंड इंजिनिअर्सना अचूक स्कीमा संदर्भ प्रदान करणे

संबंधित साधने

नेहमी विचारले जाणारे प्रश्न आणि गोपनीयता

हे टूल थेट YAML स्पेसिफिकेशन्स वाचू शकते का?

होय. एक एम्बेड केलेले YAML पार्सर ब्राउझरमध्येच पूर्णपणे `.yaml` आणि `.json` या दोन्ही OpenAPI कॉन्ट्रॅक्ट स्पेसिफिकेशन्स प्रोसेस करते.

माझे प्रोप्रायटरी API स्पेसिफिकेशन बाह्य सर्व्हर्सवर अपलोड केले जाते का?

नाही. सर्व डॉक्युमेंट पार्सिंग आणि स्कीमा रेंडरिंग केवळ तुमच्या स्थानिक ब्राउझर मेमरीमध्येच चालते.