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()
* )
*)
*/
Bước 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átung truy i địa chỉ mà mà bạn đã cấu hình trong tệp cấu hình. தாங் தாங், 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 Route và thông tin chi tiết về cách sử dụng chúng, bao gồm các thông s.
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û tuài.