আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন। তথ্য
স্পেক এডিটর ব্যবহার করে কোনও কোড না লিখে OpenAPI স্পেসিফিকেশন তৈরি ও যাচাই করুন।
স্পেক এডিটর অ্যাক্সেস করা
নিম্নলিখিত বিভাগে বর্ণিত পদ্ধতি অনুযায়ী স্পেক এডিটরে একটি OpenAPI স্পেসিফিকেশন খুলুন:
- নতুন OpenAPI স্পেসিফিকেশন তৈরি করুন
- OpenAPI স্পেসিফিকেশন ইমপোর্ট করা
- আগে থেকে থাকা OpenAPI স্পেসিফিকেশন এডিট করা
নিচে দেওয়া ছবিতে স্পেক এডিটরে খোলা Petstore API-এর স্পেসিফিকেশন দেখানো হয়েছে:
আগের ছবিতে যেমন হাইলাইট করা হয়েছে, স্পেক এডিটর আপনাকে এগুলি করতে দেয়:
- বামদিকের প্যানেলে JSON বা YAML ফর্ম্যাট ব্যবহার করে আপনার API মডেল করার জন্য OpenAPI স্পেসিফিকেশন তৈরি করুন।
- ডানদিকের প্যানেলে অটোমেটিক তৈরি হওয়া API ডকুমেন্টেশন দেখুন।
- আপনি টাইপ করার সময় OpenAPI স্পেসিফিকেশন স্ট্যান্ডার্ডের সাথে মিলিয়ে আপনার স্পেসিফিকেশন যাচাই করুন।
- আপনার OpenAPI স্পেসিফিকেশন সেভ করুন অথবা স্পেসিফিকেশন বন্ধ করুন এবং আপনার এডিট বাতিল করুন।
JSON ও YAML-এর ব্যাপারে আমাকে সাহায্য করো
JSON (জাভাস্ক্রিপ্ট অবজেক্ট নোটেশন) হল একটি হালকা ডেটা ইন্টারচেঞ্জ ফর্ম্যাট যা সাধারণ ডেটা স্ট্রাকচার ও অ্যাসোসিয়েটিভ অ্যারে দেখানোর জন্য ব্যবহার করা হয়। আরও জানতে, https://www.json.org দেখুন।
YAML (YAML Ain't Markup Language) হল ডেটা সিরিয়ালাইজেশন/রিপ্রেজেন্টেশন স্ট্যান্ডার্ড যা এমন সিনট্যাক্স প্রদান করে যা তালিকা, অ্যাসোসিয়েটিভ অ্যারে ও স্কেলারের মতো ডেটা স্ট্রাকচারের সাথে ম্যাপ করা যায়। আরও জানতে, https://yaml.org দেখুন।
JSON ও YAML, দু'টিই মেশিন-রিডেবল, তবে এগুলি মানুষও সহজে পড়তে ও বুঝতে পারে। নিচের ছবিতে JSON ও YAML ব্যবহার করে লেখা একই OpenAPI স্পেসিফিকেশন থেকে নেওয়া দুটি ছোট ছোট অংশ তুলনা করে দেখানো হয়েছে:
স্পেসিফিকেশন যাচাই করা
স্পেক এডিটর আপনার OpenAPI স্পেসিফিকেশনকে OpenAPI স্পেসিকেশন স্ট্যান্ডার্ডের সাথে যাচাই করে। আপনি টাইপ করার সময়, আপনার OpenAPI স্পেসিফিকেশনে কোনও সমস্যা থাকলে, স্পেক এডিটর ডানদিকের প্যানেলের উপরে সমস্যার ডায়ালগ দেখায় এবং সমস্যা ও তার সাথে যুক্ত লাইন নম্বর সম্পর্কে আরও তথ্য প্রদান করে যাতে আপনি সহজেই সেগুলি সংশোধন করতে পারেন।
স্পেসিফিকেশন সেভ করা
OpenAPI স্পেসিফিকেশন সেভ করতে, উপরের নেভিগেশন বারে সেভ করুন বিকল্পে ক্লিক করুন।
আপনি যদি এই প্রথমবার স্পেসিফিকেশন সেভ করেন, তাহলে আপনাকে ফাইলের নাম লিখতে বলা হবে। আপনি কোনও ফাইলের নাম উল্লেখ না করলে, ডিফল্ট হিসেবে সেটির নাম 'নামহীন' হয়ে যায়। আপনি পরে এটির নাম পরিবর্তন করতে পারবেন।
স্পেসিফিকেশন বন্ধ করা
আপনার এডিট সেভ না করেই কোনও OpenAPI স্পেসিফিকেশন বন্ধ করতে, উপরের নেভিগেশন বারে বাতিল করুন বিকল্পে ক্লিক করুন। আপনাকে স্পেসিফিকেশন তালিকায় ফিরিয়ে নিয়ে যাওয়া হবে।