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. આનો annotations ઉપયોગ Swagger API દસ્તાવેજીકરણ આપમેળે જનરેટ કરવા માટે થાય છે. દાખ્લા તરીકે:
/**
* @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.