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

আপনি 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 মার্কআপ ল্যাঙ্গুয়েজ নয়) হল একটি ডেটা সিরিয়ালাইজেশন/রিপ্রেজেন্টেশন স্ট্যান্ডার্ড যা একটি সিনট্যাক্স প্রদান করে যা একটি সিনট্যাক্স প্রদান করে যা ডেটা স্ট্রাকচার যেমন তালিকা, সহযোগী অ্যারে এবং স্কেলারগুলিতে ম্যাপ করা যেতে পারে। আরও জানতে, https://yaml.org দেখুন।

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

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

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

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

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

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

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

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