Swagger میں خود بخود API دستاویزات تیار کرنے جیسے ٹولز کا استعمال Laravel آپ کے API کے لیے دستاویزات بنانے اور برقرار رکھنے کا ایک آسان طریقہ ہے۔ Swagger ایک اوپن سورس ٹول ہے جو آپ کو اپنے APIs کو بیان کرنے، دستاویز کرنے اور جانچنے میں مدد کرتا ہے۔ یہاں ہے کہ آپ 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 cách truy cập URL tương ứng vị mạới URL 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.