OpenAPI / Swagger फ़ॉर्मेटर क्या है?

यह एक टूल है जो एक OpenAPI 3.x या Swagger 2.0 API विनिर्देश को पार्स करता है और इसे साफ़, सुसंगत रूप से इंडेंट किए गए JSON या YAML के रूप में पुनः उत्सर्जित करता है, साथ ही संस्करण और पथों तथा ऑपरेशनों की संख्या की रिपोर्ट करता है ताकि आप किसी स्पेक की जल्दी समीक्षा और मानकीकरण कर सकें।

क्या यह JSON और YAML दोनों स्पेक का समर्थन करता है?

हाँ। चूँकि JSON स्वयं मान्य YAML है, आप किसी भी प्रारूप को पेस्ट कर सकते हैं। फ़ॉर्मेट किया गया आउटपुट कैसे उत्सर्जित हो यह चुनने के लिए JSON / YAML टॉगल का उपयोग करें, जो आपको एक स्पेक को एक प्रारूप से दूसरे में परिवर्तित करने भी देता है।

क्या यह OpenAPI स्कीमा के विरुद्ध मेरे स्पेक को पूरी तरह सत्यापित करता है?

यह सत्यापित करता है कि दस्तावेज़ सुगठित JSON या YAML के रूप में पार्स होता है और संस्करण, शीर्षक, पथ और ऑपरेशन का पता लगाता है। यह हर फ़ील्ड का पूर्ण JSON Schema सत्यापन नहीं चलाता, इसलिए यह किसी ऑपरेशन के भीतर गहराई में किसी लापता आवश्यक प्रॉपर्टी को चिह्नित नहीं करेगा।

यह कौन-से संस्करण पहचानता है?

यह openapi फ़ील्ड के माध्यम से OpenAPI 3.x और swagger फ़ील्ड के माध्यम से Swagger 2.0 को लेबल करता है। उन फ़ील्डों में से किसी एक के बिना कोई भी दस्तावेज़ फ़ॉर्मेट होता है लेकिन एक अज्ञात संस्करण के रूप में चिह्नित होता है।

क्या मेरा API स्पेक कहीं अपलोड होता है?

नहीं। पार्सिंग, सत्यापन और फ़ॉर्मेटिंग पूरी तरह आपके ब्राउज़र में चलती है। आपका पेस्ट किया गया स्पेक कभी आपके डिवाइस से बाहर नहीं जाता और कुछ भी ArrayKit पर अपलोड नहीं होता, इसलिए आंतरिक या अप्रकाशित API कॉन्ट्रैक्ट निजी रहते हैं।

क्या मैं फ़ॉर्मेट किया गया परिणाम डाउनलोड कर सकता हूँ?

हाँ। फ़ॉर्मेट किए गए स्पेक को आपके द्वारा चुने गए आउटपुट प्रारूप के आधार पर openapi.json या openapi.yaml के रूप में कॉपी या डाउनलोड किया जा सकता है।

OpenAPI / Swagger फ़ॉर्मेटर

OpenAPI / Swagger स्पेसिफिकेशन (JSON या YAML) को फ़ॉर्मेट व वैलिडेट करें और पाथ तथा ऑपरेशन गिनें।

यह एक स्थानीय टूल है: यह पूरी तरह आपके ब्राउज़र में चलता है। आपका पेस्ट किया गया OpenAPI या Swagger स्पेक कभी आपके डिवाइस से बाहर नहीं जाता — कुछ भी ArrayKit या किसी सर्वर पर अपलोड नहीं होता।

YAML और JSON के बीच परिवर्तित करें

OpenAPI / Swagger फ़ॉर्मेटर के बारे में

ArrayKit OpenAPI फ़ॉर्मेटर OpenAPI और Swagger विनिर्देशों को JSON या YAML में सुंदर बनाता और सत्यापित करता है, सब कुछ आपके ब्राउज़र के अंदर। एक स्पेक पेस्ट करें और यह दस्तावेज़ को पार्स करता है, पता लगाए गए संस्करण (OpenAPI 3.x या Swagger 2.0), API शीर्षक की रिपोर्ट करता है, और गिनता है कि यह कितने पथ और ऑपरेशन परिभाषित करता है, फिर साफ़, सुसंगत रूप से इंडेंट किए गए JSON या YAML को पुनः उत्सर्जित करता है। यह उन बैकएंड और API डेवलपर्स, तकनीकी लेखकों और प्लेटफ़ॉर्म टीमों के लिए बनाया गया है जिन्हें किसी हाथ से संपादित कॉन्ट्रैक्ट को व्यवस्थित करने, JSON और YAML के बीच परिवर्तित करने, या किसी स्पेक को कमिट करने या उसे Swagger UI, कोड जनरेटर, या किसी गेटवे को देने से पहले उसकी जाँच करने का एक त्वरित तरीका चाहिए। चूँकि अनुरोध निर्माण और पार्सिंग स्थानीय रूप से होती है, आप आंतरिक या अप्रकाशित API परिभाषाओं को किसी सर्वर पर भेजे बिना फ़ॉर्मेट कर सकते हैं। विकृत YAML पकड़ने, ऑपरेशन गणना की पुष्टि करने, और किसी रेपो में फ़ॉर्मेटिंग को मानकीकृत करने के लिए इसका उपयोग करें।

विशेषताएँ

JSON और YAML दोनों इनपुट स्वीकार करता है — JSON मान्य YAML है, इसलिए दोनों पार्स होते हैं
स्पेक संस्करण का पता लगाता और लेबल करता है: OpenAPI 3.x या Swagger 2.0
API शीर्षक के साथ-साथ पथों और ऑपरेशनों की एक लाइव गणना की रिपोर्ट करता है
आठ HTTP ऑपरेशन गिनता है (get, put, post, delete, options, head, patch, trace)
आउटपुट को प्रिटी-प्रिंटेड JSON और 2-स्पेस YAML के बीच टॉगल करें
जब कोई दस्तावेज़ विकृत हो तो अंतर्निहित संदेश के साथ पार्स त्रुटियाँ सामने लाता है
जब कोई openapi या swagger फ़ील्ड मौजूद न हो तो चेतावनी देता है ताकि अज्ञात स्पेक अलग दिखें
फ़ॉर्मेट किए गए परिणाम को openapi.json या openapi.yaml के रूप में डाउनलोड करें

OpenAPI / Swagger फ़ॉर्मेटर का उपयोग कैसे करें

अपने OpenAPI या Swagger स्पेक (JSON या YAML) को इनपुट पैनल में पेस्ट करें
टूलबार में JSON / YAML टॉगल के साथ आउटपुट प्रारूप चुनें
संस्करण, शीर्षक, पथ गणना और ऑपरेशन गणना के लिए सारांश बैनर पढ़ें
फ़ॉर्मेट किए गए स्पेक को कॉपी करें या इसे openapi.json या openapi.yaml के रूप में डाउनलोड करें

उदाहरण

इनपुट

openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
  /users:
    get: { summary: List users, responses: { '200': { description: OK } } }
    post: { summary: Create user, responses: { '201': { description: Created } } }

आउटपुट

openapi: 3.0.3
info:
  title: Example API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: OK
    post:
      summary: Create user
      responses:
        '201':
          description: Created

एक न्यूनतम OpenAPI 3.0 स्पेक — फ़ॉर्मेटर 'OpenAPI 3.0.3 · Example API · 1 path · 2 operations' की रिपोर्ट करता है।

सामान्य त्रुटियाँ और समस्या निवारण

सारांश 'Unknown — no openapi/swagger field' दिखाता है। — एक शीर्ष-स्तरीय openapi: 3.x.x (या swagger: '2.0') फ़ील्ड जोड़ें; इसके बिना संस्करण का पता नहीं लगाया जा सकता, हालाँकि दस्तावेज़ फिर भी फ़ॉर्मेट होता है।
एक YAML पार्स त्रुटि दिखाई देती है, अक्सर खराब इंडेंटेशन या एक टैब वर्ण के बारे में। — YAML इंडेंटेशन-संवेदनशील है और टैब वर्जित करता है — टैब को स्पेस से बदलें और की को सुसंगत रूप से संरेखित करें, फिर पुनः पेस्ट करें।
ऑपरेशन गणना अपेक्षा से कम दिखती है। — केवल आठ मानक HTTP मेथड गिने जाते हैं; x-amazon-apigateway-integration जैसे विक्रेता एक्सटेंशन और parameters/servers प्रविष्टियाँ ऑपरेशन नहीं हैं।
पेस्ट करने के बाद 'The document is empty or not an object'। — इनपुट एक स्केलर या null में पार्स हुआ — सुनिश्चित करें कि आपने पूरा स्पेक ऑब्जेक्ट पेस्ट किया, कोई एकल स्ट्रिंग या आंशिक अंश नहीं।

अक्सर पूछे जाने वाले प्रश्न

OpenAPI / Swagger फ़ॉर्मेटर क्या है?: यह एक टूल है जो एक OpenAPI 3.x या Swagger 2.0 API विनिर्देश को पार्स करता है और इसे साफ़, सुसंगत रूप से इंडेंट किए गए JSON या YAML के रूप में पुनः उत्सर्जित करता है, साथ ही संस्करण और पथों तथा ऑपरेशनों की संख्या की रिपोर्ट करता है ताकि आप किसी स्पेक की जल्दी समीक्षा और मानकीकरण कर सकें।
क्या यह JSON और YAML दोनों स्पेक का समर्थन करता है?: हाँ। चूँकि JSON स्वयं मान्य YAML है, आप किसी भी प्रारूप को पेस्ट कर सकते हैं। फ़ॉर्मेट किया गया आउटपुट कैसे उत्सर्जित हो यह चुनने के लिए JSON / YAML टॉगल का उपयोग करें, जो आपको एक स्पेक को एक प्रारूप से दूसरे में परिवर्तित करने भी देता है।
क्या यह OpenAPI स्कीमा के विरुद्ध मेरे स्पेक को पूरी तरह सत्यापित करता है?: यह सत्यापित करता है कि दस्तावेज़ सुगठित JSON या YAML के रूप में पार्स होता है और संस्करण, शीर्षक, पथ और ऑपरेशन का पता लगाता है। यह हर फ़ील्ड का पूर्ण JSON Schema सत्यापन नहीं चलाता, इसलिए यह किसी ऑपरेशन के भीतर गहराई में किसी लापता आवश्यक प्रॉपर्टी को चिह्नित नहीं करेगा।
यह कौन-से संस्करण पहचानता है?: यह openapi फ़ील्ड के माध्यम से OpenAPI 3.x और swagger फ़ील्ड के माध्यम से Swagger 2.0 को लेबल करता है। उन फ़ील्डों में से किसी एक के बिना कोई भी दस्तावेज़ फ़ॉर्मेट होता है लेकिन एक अज्ञात संस्करण के रूप में चिह्नित होता है।
क्या मेरा API स्पेक कहीं अपलोड होता है?: नहीं। पार्सिंग, सत्यापन और फ़ॉर्मेटिंग पूरी तरह आपके ब्राउज़र में चलती है। आपका पेस्ट किया गया स्पेक कभी आपके डिवाइस से बाहर नहीं जाता और कुछ भी ArrayKit पर अपलोड नहीं होता, इसलिए आंतरिक या अप्रकाशित API कॉन्ट्रैक्ट निजी रहते हैं।
क्या मैं फ़ॉर्मेट किया गया परिणाम डाउनलोड कर सकता हूँ?: हाँ। फ़ॉर्मेट किए गए स्पेक को आपके द्वारा चुने गए आउटपुट प्रारूप के आधार पर openapi.json या openapi.yaml के रूप में कॉपी या डाउनलोड किया जा सकता है।