স্পেক এডিটর ব্যবহার করে স্পেসিফিকেশন তৈরি করুন

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

স্পেক এডিটর ব্যবহার করে কোনো কোড না লিখেই ওপেনএপিআই স্পেসিফিকেশন তৈরি ও যাচাই করুন।

স্পেক এডিটর অ্যাক্সেস করুন

নিম্নলিখিত বিভাগগুলিতে বর্ণিত পদ্ধতি অনুসারে স্পেক এডিটর-এ একটি OpenAPI স্পেসিফিকেশন খুলুন:

• একটি নতুন ওপেনএপিআই স্পেসিফিকেশন তৈরি করুন
• একটি ওপেনএপিআই স্পেসিফিকেশন আমদানি করুন
• বিদ্যমান একটি ওপেনএপিআই স্পেসিফিকেশন সম্পাদনা করুন

নিম্নলিখিত চিত্রে স্পেক এডিটরে খোলা Petstore API-এর স্পেসিফিকেশনটি দেখানো হয়েছে:

পূর্ববর্তী চিত্রে যেমনটি তুলে ধরা হয়েছে, স্পেক এডিটর আপনাকে নিম্নলিখিত কাজগুলো করতে সক্ষম করে:

• বাম দিকের প্যানেলে JSON বা YAML ফরম্যাট ব্যবহার করে আপনার API মডেল করার জন্য OpenAPI স্পেসিফিকেশন তৈরি করুন।
• ডান প্যানে স্বয়ংক্রিয়ভাবে তৈরি হওয়া এপিআই ডকুমেন্টেশন দেখুন।
• টাইপ করার সময় আপনার স্পেসিফিকেশনটি OpenAPI স্পেসিফিকেশন স্ট্যান্ডার্ডের সাথে যাচাই করুন ।
• আপনার OpenAPI স্পেসিফিকেশন সংরক্ষণ করুন অথবা স্পেকটি বন্ধ করে আপনার সম্পাদনাগুলো বাতিল করুন।

JSON এবং YAML নিয়ে আমাকে সাহায্য করুন।

JSON (জাভাস্ক্রিপ্ট অবজেক্ট নোটেশন) হলো একটি হালকা ডেটা আদান-প্রদান ফরম্যাট, যা সাধারণ ডেটা কাঠামো এবং অ্যাসোসিয়েটিভ অ্যারে উপস্থাপনের জন্য ব্যবহৃত হয়। আরও জানতে, https://www.json.org দেখুন।

YAML (YAML Ain't Markup Language) হলো একটি ডেটা সিরিয়ালাইজেশন/রিপ্রেজেন্টেশন স্ট্যান্ডার্ড, যা এমন একটি সিনট্যাক্স প্রদান করে যাকে লিস্ট, অ্যাসোসিয়েটিভ অ্যারে এবং স্কেলারের মতো ডেটা স্ট্রাকচারের সাথে ম্যাপ করা যায়। আরও জানতে, https://yaml.org দেখুন।

JSON এবং YAML উভয়ই মেশিন-পাঠযোগ্য, তবে মানুষের জন্যও পড়া ও বোঝা সহজ। নিচের চিত্রে JSON এবং YAML ব্যবহার করে লেখা একই OpenAPI স্পেসিফিকেশনের দুটি সংক্ষিপ্ত অংশের তুলনা করা হয়েছে:

একটি স্পেসিফিকেশন যাচাই করুন

স্পেক এডিটর আপনার ওপেনএপিআই স্পেসিফিকেশনকে ওপেনএপিআই স্পেসিফিকেশন স্ট্যান্ডার্ডের সাথে মিলিয়ে যাচাই করে। আপনি টাইপ করার সময়, যদি আপনার ওপেনএপিআই স্পেসিফিকেশনে কোনো ভুল থাকে, তাহলে স্পেক এডিটর ডানদিকের প্যানেলের উপরে এরর ডায়ালগটি প্রদর্শন করে এবং ভুলগুলো ও সেগুলোর সংশ্লিষ্ট লাইন নম্বর সম্পর্কে আরও তথ্য দেয়, যাতে আপনি সহজেই সেগুলো সংশোধন করতে পারেন।

একটি স্পেসিফিকেশন সংরক্ষণ করুন

একটি OpenAPI স্পেসিফিকেশন সংরক্ষণ করতে, উপরের নেভিগেশন বারে থাকা সেভ (Save) বোতামে ক্লিক করুন।

আপনি যদি প্রথমবারের মতো স্পেসিফিকেশনটি সংরক্ষণ করেন, তাহলে আপনাকে একটি ফাইলের নাম লিখতে বলা হবে। আপনি যদি কোনো ফাইলের নাম উল্লেখ না করেন, তবে এর নাম ডিফল্টভাবে ‘Untitled’ হয়ে যাবে। আপনি পরে এটির নাম পরিবর্তন করতে পারবেন।

একটি স্পেসিফিকেশন বন্ধ করুন

আপনার সম্পাদনাগুলি সংরক্ষণ না করে একটি OpenAPI স্পেসিফিকেশন বন্ধ করতে, উপরের নেভিগেশন বারে থাকা Cancel- এ ক্লিক করুন। আপনাকে স্পেসিফিকেশন তালিকায় ফিরিয়ে আনা হবে।