Swagger স্বয়ংক্রিয়ভাবে API ডকুমেন্টেশন তৈরি করার মতো সরঞ্জামগুলি ব্যবহার করা Laravel আপনার API-এর জন্য ডকুমেন্টেশন তৈরি এবং বজায় রাখার একটি সুবিধাজনক উপায়। Swagger একটি ওপেন-সোর্স টুল যা আপনাকে আপনার API বর্ণনা, নথি এবং পরীক্ষা করতে সাহায্য করে। API ডকুমেন্টেশন তৈরি করতে আপনি কীভাবে Swagger ব্যবহার করতে পারেন তা এখানে: Laravel
ধাপ 1: Swagger এর জন্য ইনস্টল করুন Laravel
Swagger package এর জন্য ইনস্টল করতে কম্পোজার ব্যবহার করুন Laravel । package এই উদ্দেশ্যে একটি জনপ্রিয় হয় darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
ধাপ 2: কনফিগার করুন Swagger
ইনস্টলেশনের পরে, আপনাকে আপনার অ্যাপ্লিকেশনের Swagger ডিরেক্টরিতে ডকুমেন্টেশন প্রকাশ করতে হবে। আপনি কমান্ড চালানোর মাধ্যমে এটি করতে পারেন: public Laravel Artisan
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
config/l5-swagger.php তারপর, আপনার অ্যাপ্লিকেশনের জন্য কনফিগার করার জন্য আপনাকে কনফিগারেশন ফাইলটি সম্পাদনা করতে হবে Swagger, যেখানে ডকুমেন্টেশন প্রকাশ করা হবে তা উল্লেখ করা সহ।
ধাপ 3: ব্যবহার করুন Annotations
annotations আপনার অ্যাপ্লিকেশনে আপনার রুটের ডকুমেন্টেশন বর্ণনা করতে ব্যবহার করুন Laravel । এগুলি স্বয়ংক্রিয়ভাবে API ডকুমেন্টেশন তৈরি করতে annotations ব্যবহৃত হয় । Swagger উদাহরণ স্বরূপ:
/**
* @OA\Get(
* path="/api/users",
* operationId="getUsersList",
* tags={"Users"},
* summary="Get list of users",
* description="Returns list of users",
* @OA\Response(
* response=200,
* description="Successful operation",
* @OA\JsonContent()
* )
*)
*/
পদক্ষেপ 4: Truy cập Tài liệu API Swagger
Khi bạn đã cấu hình và đặt các chú thích tương ứng, bạn có thể truy cập tài liệu API Swagger bằng cach truy cập URL tương ứng cập URL tương ứng vứng nh trong tệp cấu hình. Thông thường, URL này sẽ có định dạng http://your-app-url/api/documentation ।
Swagger sẽ hiển thị tài liệu về các রুট và thông tin chi tiết về cách sử dụng chúng, bao gồm các thông số và phản hồi kỳ vọng.
Sử dụng Swagger trong Laravel giúp tạo tài liệu API tự động và tiết kiệm thời gian trong việc tạo và duy trì tài liệu.