Swagger ਵਿੱਚ API ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਸਵੈਚਲਿਤ ਤੌਰ 'ਤੇ ਤਿਆਰ ਕਰਨ ਵਰਗੇ ਟੂਲਸ ਦੀ ਵਰਤੋਂ ਕਰਨਾ Laravel ਤੁਹਾਡੇ API ਲਈ ਦਸਤਾਵੇਜ਼ ਬਣਾਉਣ ਅਤੇ ਬਣਾਈ ਰੱਖਣ ਦਾ ਇੱਕ ਸੁਵਿਧਾਜਨਕ ਤਰੀਕਾ ਹੈ। Swagger ਇੱਕ ਓਪਨ-ਸੋਰਸ ਟੂਲ ਹੈ ਜੋ ਤੁਹਾਡੇ APIs ਦਾ ਵਰਣਨ ਕਰਨ, ਦਸਤਾਵੇਜ਼ ਬਣਾਉਣ ਅਤੇ ਟੈਸਟ ਕਰਨ ਵਿੱਚ ਤੁਹਾਡੀ ਮਦਦ ਕਰਦਾ ਹੈ। ਏਪੀਆਈ ਦਸਤਾਵੇਜ਼ ਬਣਾਉਣ ਲਈ ਤੁਸੀਂ 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 cập URL tương ứng với cập 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.