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 cách truy cập URL tương ứng vị bạch tươ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।