Swagger একটি বিশেষ টুল যা স্বয়ংক্রিয়ভাবে আপনার অ্যাপ্লিকেশনের RESTful API নথি রচনা করে।
এর সুবিধাটি এই সত্যের মধ্যে রয়েছে যে এটি আপনাকে কেবল অ্যাপ্লিকেশনটির সমস্ত শেষ পয়েন্টগুলি দেখতে দেয় না, তবে অবিলম্বে একটি অনুরোধ পাঠিয়ে এবং একটি প্রতিক্রিয়া পাওয়ার মাধ্যমে তাদের কার্যকারিতা পরীক্ষা করে।
Swagger অ্যাক্সেস করার জন্য, আপনাকে প্রকাশিত অ্যাপ্লিকেশনে Preview বোতাম টিপুন এবং প্রয়োজনীয় প্রকাশনা পরিকল্পনার নামে ক্লিক করতে হবে ( Deploy Plan )।
নতুন খোলা উইন্ডোতে উপলব্ধ এন্ডপয়েন্ট এবং এই শেষ পয়েন্টগুলির সাথে সম্পর্কিত পদ্ধতিগুলির একটি তালিকা দেখানো হয়েছে৷ কিছু অনুরোধ শুধুমাত্র অনুমোদিত ব্যবহারকারীদের নির্দিষ্ট গোষ্ঠীর জন্য উপলব্ধ ( Endpoints বিভাগে প্রতিটি নির্দিষ্ট অনুরোধের জন্য Auth module Middleware দেখুন)। শুধুমাত্র অনুমোদিত ব্যবহারকারীদের জন্য অনুমোদিত অনুরোধের জন্য একটি Bearer Token প্রয়োজন।
আপনি এই টোকেন ( Auth বিভাগ, POST /auth অনুরোধ) পেতে সরাসরি Swagger সংশ্লিষ্ট এন্ডপয়েন্ট অ্যাক্সেস করতে পারেন।
Try it out ব্যবহার করে দেখুন এবং একটি টোকেন পেতে লগইন এবং পাসওয়ার্ড লিখুন টিপুন।
Execute অনুরোধ পাঠানো হবে। যদি এটি সফলভাবে হয় তবে আপনি Bearer token মান সহ একটি token ক্ষেত্র দেখতে পাবেন।
একটি অনুমোদিত ব্যবহারকারী টোকেন পাওয়ার দ্বিতীয় উপায় হল যে টোকেনটি স্থাপন করা অ্যাপ্লিকেশনটির অনুরোধের অংশে পাওয়া যেতে পারে।
- বিকাশকারীর টুল খুলতে আপনার ওয়েব ব্রাউজারে F12 টিপুন।
- আপনার নিয়োজিত অ্যাপ্লিকেশনে যেকোনো অনুরোধ পাঠান (উদাহরণস্বরূপ, টেবিল আপডেট করতে)। যে ব্যবহারকারী এই অনুরোধটি পাঠাচ্ছেন তাকে এই শেষ পয়েন্ট অ্যাক্সেস করার জন্য অনুমোদিত হতে হবে।
- Network ট্যাব খুলুন এবং সংশ্লিষ্ট অনুরোধটি খুঁজুন।
- Headers ট্যাবে যান এবং Request Headers বিভাগ খুঁজুন। Bearer token Authorization অধীনে উপস্থাপন করা হবে।
পূর্ববর্তী ধাপে অনুলিপি করা মানটি Authorize এবং পেস্ট করার মাধ্যমে Swagger কে Bearer token প্রদান করুন।
পরীক্ষার অনুরোধের জন্য পছন্দসই গোষ্ঠী এবং আপনি যে পদ্ধতিটি চালাতে চান তা নির্বাচন করুন। Try it out এবং অনুরোধ ইনপুট পরামিতি পূরণ করুন টিপুন। প্রতিক্রিয়া চালানোর জন্য Execute ক্লিক করুন।
সর্বাধিক প্রত্যাশিত প্রতিক্রিয়া, যদি অনুরোধটি সার্ভার দ্বারা সঠিকভাবে প্রক্রিয়া করা হয়, কোড 200 থাকে এবং প্রতিক্রিয়া গঠনটি কেমন হওয়া উচিত তা দেখায়।
401 - অনুরোধটি সফলভাবে সম্পন্ন হয়নি কারণ প্রয়োজনীয় অনুমোদন টোকেন অনুপস্থিত বা অবৈধ।
404 - অনুরোধটি সফলভাবে প্রক্রিয়া করা হয়েছে, কিন্তু অনুরোধ করা সংস্থানটি পাওয়া যায়নি।
422 - অনুরোধের ইনপুটে ভুল প্যারামিটার পাস করা হয়েছে।
500 - সার্ভার দ্বারা অনুরোধ প্রক্রিয়াকরণে একটি ত্রুটি৷
কাস্টম ত্রুটি বাড়ান
কাস্টম বিপি এবং সম্পর্কিত অনুরোধগুলির জন্য, বিপি সম্পাদকে Raise Error ব্লক ব্যবহার করে বর্ণনা সহ কাস্টম ত্রুটি কোড তৈরি করা সম্ভব। এই ধরনের প্রক্রিয়ার একটি উদাহরণ নীচে দেওয়া হল:
এই ক্ষেত্রে, উপরের BP-এর সাথে যুক্ত এন্ডপয়েন্টের অনুরোধ ব্যর্থ হলে, সার্ভার DB: Create Candidate block । এই উদাহরণে ত্রুটি কোড ব্যবহারকারী নির্দিষ্ট যে কোনো একটি হতে পারে.
দ্রষ্টব্য: HTTP 418 I'm a teapot ক্লায়েন্ট ত্রুটি প্রতিক্রিয়া কোড নির্দেশ করে যে সার্ভার কফি তৈরি করতে অস্বীকার করে কারণ এটি স্থায়ীভাবে, একটি চাপানি। একটি সম্মিলিত কফি/চা পাত্র যা সাময়িকভাবে কফির বাইরে থাকে তার পরিবর্তে 503 ফেরত দেওয়া উচিত। এই ত্রুটিটি 1998 এবং 2014 সালে এপ্রিল ফুলের জোকসে সংজ্ঞায়িত Hyper Text Coffee Pot Control Protocol একটি রেফারেন্স।
