स्पेसिफ़िकेशन एडिटर का इस्तेमाल करके स्पेसिफ़िकेशन बनाना

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

स्पेसिफ़िकेशन एडिटर का इस्तेमाल करके, कोई कोड लिखे बिना OpenAPI स्पेसिफ़िकेशन बनाएं और उनकी पुष्टि करें.

स्पेसिफ़िकेशन एडिटर को ऐक्सेस करना

स्पेसिफ़िकेशन एडिटर में OpenAPI स्पेसिफ़िकेशन खोलें. इसके लिए, नीचे दिए गए सेक्शन में दिया गया तरीका अपनाएं:

• नया OpenAPI स्पेसिफ़िकेशन बनाना
• OpenAPI स्पेसिफ़िकेशन इंपोर्ट करना
• मौजूदा OpenAPI स्पेसिफ़िकेशन में बदलाव करना

इस इमेज में, स्पेसिफ़िकेशन एडिटर में Petstore API के लिए स्पेसिफ़िकेशन को दिखाया गया है:

जैसा कि पिछले फ़ोटो में हाइलाइट किया गया है, स्पेसिफ़िकेशन एडिटर की मदद से ये काम किए जा सकते हैं:

• बाईं ओर मौजूद पैनल में, JSON या YAML फ़ॉर्मैट का इस्तेमाल करके, अपने एपीआई को मॉडल करने के लिए OpenAPI स्पेसिफ़िकेशन बनाएं.
• दाएं पैनल में, अपने-आप जनरेट हुआ एपीआई दस्तावेज़ देखें.
• टाइप करते समय, OpenAPI Specification स्टैंडर्ड के हिसाब से अपने स्पेसिफ़िकेशन की पुष्टि करें.
• अपना OpenAPI स्पेसिफ़िकेशन सेव करें या स्पेसिफ़िकेशन बंद करें और अपने बदलाव रद्द करें.

JSON और YAML के बारे में मदद पाना

JSON (JavaScript Object Notation), डेटा इंटरचेंज का एक हल्का फ़ॉर्मैट है. इसका इस्तेमाल, आसान डेटा स्ट्रक्चर और असोसिएटिव ऐरे को दिखाने के लिए किया जाता है. ज़्यादा जानने के लिए, https://www.json.org पर जाएं.

YAML (YAML Ain't Markup Language), डेटा को सीरियलाइज़ करने/प्रज़ेंट करने का एक स्टैंडर्ड है. यह एक ऐसा सिंटैक्स भी उपलब्ध कराता है जिसे डेटा स्ट्रक्चर, जैसे कि सूचियों, असोसिएटिव ऐरे, और स्केलर पर मैप किया जा सकता है. ज़्यादा जानने के लिए, https://yaml.org पर जाएं.

JSON और YAML, दोनों को मशीन आसानी से पढ़ सकती है. हालांकि, इन्हें इंसान भी आसानी से पढ़ और समझ सकते हैं. नीचे दिए गए इलस्ट्रेशन में, JSON और YAML का इस्तेमाल करके लिखे गए एक ही OpenAPI स्पेसिफ़िकेशन के दो छोटे हिस्सों की तुलना की गई है:

किसी खास जानकारी की पुष्टि करना

स्पेसिफ़िकेशन एडिटर, OpenAPI स्पेसिफ़िकेशन के स्टैंडर्ड के हिसाब से आपके OpenAPI स्पेसिफ़िकेशन की पुष्टि करता है. टाइप करते समय, अगर आपके OpenAPI स्पेसिफ़िकेशन में गड़बड़ियां हैं, तो स्पेसिफ़िकेशन एडिटर, दाएं पैनल में सबसे ऊपर गड़बड़ी वाला डायलॉग बॉक्स दिखाता है. साथ ही, गड़बड़ियों और उनसे जुड़ी लाइन नंबर के बारे में ज़्यादा जानकारी देता है, ताकि आप उन्हें आसानी से ठीक कर सकें.

स्पेसिफ़िकेशन सेव करना

OpenAPI स्पेसिफ़िकेशन सेव करने के लिए, सबसे ऊपर मौजूद नेविगेशन बार में सेव करें पर क्लिक करें.

अगर आपने पहली बार स्पेसिफ़िकेशन सेव किया है, तो आपसे फ़ाइल का नाम डालने के लिए कहा जाएगा. अगर फ़ाइल का नाम नहीं दिया जाता है, तो डिफ़ॉल्ट रूप से फ़ाइल का नाम 'बिना टाइटल वाला' हो जाता है. इसे बाद में नाम दिया जा सकता है.

स्पेसिफ़िकेशन बंद करना

अपने बदलावों को सेव किए बिना, OpenAPI स्पेसिफ़िकेशन को बंद करने के लिए, सबसे ऊपर मौजूद नेविगेशन बार में रद्द करें पर क्लिक करें. इसके बाद, आपको स्पेसिफ़िकेशन की सूची पर वापस ले जाया जाएगा.