Naudojant tokius įrankius kaip Swagger automatinis API dokumentacijos generavimas Laravel yra patogus būdas kurti ir prižiūrėti API dokumentus. Swagger yra atvirojo kodo įrankis, padedantis aprašyti, dokumentuoti ir išbandyti API. Štai kaip galite naudoti Swagger kurdami Laravel API dokumentus:
1 veiksmas: Swagger įdiekite Laravel
Norėdami įdiegti Swagger package for, naudokite kompozitorių Laravel. Populiarus package šiam tikslui yra darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
2 veiksmas: konfigūruokite Swagger
Įdiegę dokumentaciją turite paskelbti savo programos Swagger kataloge. Tai galite padaryti vykdydami komandas: public Laravel Artisan
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
Tada turite redaguoti konfigūracijos failą, config/l5-swagger.php kad sukonfigūruotumėte Swagger savo programą, įskaitant vietą, kurioje bus paskelbta dokumentacija.
3 veiksmas: naudokite Annotations
Naudokite annotations norėdami apibūdinti savo maršrutų dokumentaciją savo Laravel programoje. Jie annotations naudojami Swagger automatiškai generuoti API dokumentaciją. Pavyzdžiui:
/**
* @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
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 cach truy cᛰệỡằng cách truy cứi a chỉ mà bạn đã cấu hì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 Maršrutas và thông tin chi tiết về cach sử dụng chúng, bao gồm các v. thông số và phến
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.