लिखने के लिए YAML
लंबे विवरण YAML ब्लॉक टेक्स्ट में बेहतर पढ़े जाते हैं, और टिप्पणियों से आप रिव्यू करने वालों के लिए स्पेसिफ़िकेशन पर नोट जोड़ सकते हैं।
$ref पाथ या रिस्पॉन्स कोड तोड़े बिना API स्पेसिफ़िकेशन को JSON और YAML के बीच बदलें।
आउटपुट की हर पंक्ति, डिफ़ॉल्ट फ़ॉर्मेटिंग में, उसमें मौजूद मान के पाथ के साथ। पाथ कॉपी करने के लिए किसी पंक्ति पर क्लिक करें।
पूरी तरह आपके ब्राउज़र में चलता है: कुछ भी अपलोड नहीं होता। स्पैम और बॉट्स को रोकने के लिए उचित-उपयोग सीमाएँ लागू हैं (प्रति इनपुट 5 MB, कन्वर्ज़न पर दर-सीमा)।
हाथ से कन्वर्ट किए गए स्पेसिफ़िकेशन दो बातों से टूटते हैं: YAML टिप्पणी शुरू करने वाला #, और पूर्णांक बन जाने वाले स्टेटस कोड। दोनों संभाले जाते हैं।
{
"paths": {
"/pets/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
}
}
},
"4XX": {
"description": "Client error"
}
}
}
}
}
} paths:
/pets/{id}:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
4XX:
description: Client error हाथ से लिखा, बिना कोट्स पर स्विच करें और देखें कि $ref null बन जाता है और वाइल्डकार्ड होस्ट पार्स नहीं होता।
कन्वर्ट करने के बाद लिंटर चलाएँ, ताकि सिर्फ़ सिंटैक्स नहीं, स्पेसिफ़िकेशन भी जाँचा जाए। यहाँ संपादन करते समय हर लोकल $ref जाँचा जाता है।
# Lint the converted spec (OpenAPI 3.x and Swagger 2.0)
npx @redocly/cli lint openapi.yaml लंबे विवरण YAML ब्लॉक टेक्स्ट में बेहतर पढ़े जाते हैं, और टिप्पणियों से आप रिव्यू करने वालों के लिए स्पेसिफ़िकेशन पर नोट जोड़ सकते हैं।
कोड जनरेटर, गेटवे और SDK अक्सर JSON सबसे तेज़ लोड करते हैं, और कई स्पेसिफ़िकेशन को /openapi.json पर उपलब्ध कराते हैं।
दोनों फ़ॉर्मेट एक ही API का वर्णन करते हैं। किसी भी दिशा में बेझिझक कन्वर्ट करें; स्पेसिफ़िकेशन का कुछ भी नहीं खोता।
जहाँ भी JSON और YAML मिलते हैं, उसके लिए कन्वर्टर, वैलिडेटर और चरण-दर-चरण गाइड।
openapi.json पेस्ट या अपलोड करें और दाएँ पैन से YAML कॉपी करें, या उसे openapi.yaml के रूप में डाउनलोड करें। संरचना, $ref पॉइंटर, उदाहरण और विवरण ठीक वैसे ही रहते हैं।
हाँ। कन्वर्टर डॉक्यूमेंट की संरचना पर काम करता है, इसलिए Swagger 2.0, OpenAPI 3.0 और OpenAPI 3.1 स्पेसिफ़िकेशन दोनों दिशाओं में एक ही तरह कन्वर्ट होते हैं।
YAML में स्पेस के बाद आने वाला # टिप्पणी शुरू करता है। कोट्स के बिना $ref: के बाद की हर चीज़ टिप्पणी मानी जाती और रेफ़रेंस खाली रह जाता। कन्वर्टर इसे अपने-आप कोट करता है।
OpenAPI में रिस्पॉन्स कोड का स्ट्रिंग कुंजी होना ज़रूरी है। YAML में बिना कोट का 200 एक पूर्णांक है; ज़्यादातर टूल इसे स्वीकार करते हैं, पर सख़्त वैलिडेटर नहीं। कोट करने से स्पेसिफ़िकेशन हर जगह मान्य रहता है।
एडिटर के ऊपर के टॉगल से दिशा को YAML → JSON पर करें, या YAML से JSON कन्वर्टर इस्तेमाल करें। YAML के एंकर विस्तृत कर दिए जाते हैं, क्योंकि JSON में उस तरह के रेफ़रेंस नहीं होते।