OpenAPI স্পেসিফিকেশন ভিউয়ার

ইন্টারেক্টিভ ও অনুসন্ধানযোগ্য API ডকুমেন্টেশন রেন্ডার করতে Swagger/OpenAPI স্পেসিফিকেশন দেখুন।

OpenAPI Viewer সম্পর্কে — বিস্তারিত গাইড

বিভাগ: DevOps ও মানদণ্ড ১০০% ব্রাউজার-ভিত্তিক

OpenAPI Viewer হলো RESTful API কন্ট্রাক্ট পরীক্ষা করার জন্য একটি ক্লায়েন্ট-সাইড ডকুমেন্টেশন রিডার। এটি কোনো লোকাল Swagger UI ইনস্টলেশন বা ক্লাউড ডিপেন্ডেন্সি ছাড়াই JSON বা YAML ফরম্যাটে থাকা Swagger 2.0 এবং OpenAPI 3.0 / 3.1 স্পেসিফিকেশন রেন্ডার করে।

এটি সমস্ত এন্ডপয়েন্টের জন্য পরিচ্ছন্ন ও গ্রুপভিত্তিক সাইডবার নেভিগেশন প্রদান করে; যেখানে পাথ, HTTP মেথড (GET, POST, PUT, DELETE), হেডার প্যারামিটার, কোয়েরি স্ট্রিং, স্ট্রাকচার্ড রিকোয়েস্ট বডি, HTTP রেসপন্স কোড এবং ডেটা স্কিমা স্পষ্টভাবে প্রদর্শিত হয়।

#openapi #swagger #api #docs #rest #yaml #json

মূল বৈশিষ্ট্য ও সক্ষমতা

  • JSON এবং YAML ফরম্যাটে Swagger 2.0 ও OpenAPI 3.0 / 3.1 স্পেসিফিকেশন সমর্থন করে
  • ক্যাটাগরিভিত্তিক এন্ডপয়েন্ট, HTTP মেথড এবং স্ট্যাটাস কোড প্রদর্শনকারী ইন্টারেক্টিভ সাইডবার
  • নেস্টেড ডেটা মডেল ও প্রোপার্টি কনস্ট্রেইন্ট প্রদর্শনের জন্য ডিপ `$ref` স্কিমা রেজোলিউশন
  • প্রোপাইটরি এন্টারপ্রাইজ API কন্ট্রাক্ট সুরক্ষিত রাখতে ১০০% ক্লায়েন্ট-সাইড অফলাইন পার্সিং

ব্যবহারের নিয়ম

  1. 1

    আপনার `swagger.json` বা `openapi.yaml` টেক্সট পেস্ট করুন, অথবা সরাসরি স্পেক ফাইলটি আপলোড করুন।

  2. 2

    ইন্টারেক্টিভ ভিউয়ারে রেন্ডার হওয়া স্ট্রাকচার্ড API ডকুমেন্টেশন ব্রাউজ করুন।

  3. 3

    রিকোয়েস্ট হেডার, রিকোয়েস্ট পেলোড স্কিমা এবং রেসপন্স স্যাম্পল পরীক্ষা করতে যেকোনো এন্ডপয়েন্ট এক্সপ্যান্ড করুন।

সাধারণ ব্যবহারের ক্ষেত্র

  • → ডেডিকেটেড Swagger UI সার্ভার প্রস্তুত না করেই ব্যাকএন্ড API ডেফিনিশন অডিট করা
  • → হাতে লেখা OpenAPI স্পেসিফিকেশনে কোনো অবৈধ বা ভুল `$ref` পয়েন্টার আছে কিনা তা যাচাই (sanity check) করা
  • → API ইন্টিগ্রেশনের সময় ফ্রন্টএন্ড ইঞ্জিনিয়ারদের সঠিক স্কিমা রেফারেন্স সরবরাহ করা

সম্পর্কিত টুলসমূহ

সাধারণ প্রশ্নাবলি ও গোপনীয়তা

এই টুলটি কি সরাসরি YAML স্পেসিফিকেশন পড়তে পারে?

হ্যাঁ। একটি এম্বেডেড YAML পার্সার ব্রাউজারের মধ্যেই সম্পূর্ণভাবে `.yaml` এবং `.json` উভয় ধরনের OpenAPI কন্ট্রাক্ট স্পেসিফিকেশন প্রসেস করে।

আমার প্রোপাইটরি API স্পেসিফিকেশন কি কোনো এক্সটার্নাল সার্ভারে আপলোড করা হয়?

না। সমস্ত ডকুমেন্ট পার্সিং এবং স্কিমা রেন্ডারিং সম্পূর্ণরূপে আপনার লোকাল ব্রাউজার মেমরির ভেতরে সম্পন্ন হয়।