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 cập URL tương ứng với 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.