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
ఖి బాన్ đã 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ấp truy నేను địa chỉ 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 రూట్ 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.