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

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

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

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

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

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

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

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

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

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

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

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