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

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

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

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

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

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

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

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

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

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

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

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

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

किसी स्पेसिफ़िकेशन की पुष्टि करना

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

किसी खास जानकारी को सेव करना

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

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

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

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