close

Awtomatikament Iġġenera Dokumentazzjoni API fi Laravel ma Swagger

L-użu ta' għodod simili Swagger biex tiġġenera awtomatikament id-dokumentazzjoni tal-API Laravel huwa mod konvenjenti biex toħloq u żżomm id-dokumentazzjoni għall-API tiegħek. Swagger hija għodda open-source li tgħinek tiddeskrivi, tiddokumenta u tittestja l-APIs tiegħek. Hawn kif tista' tuża Swagger biex Laravel tiġġenera dokumentazzjoni tal-API:

Pass 1: Installa Swagger għal Laravel

Uża l-kompożitur biex tinstalla Swagger package għal Laravel. A popolari package għal dan il-għan huwa darkaonline/l5-swagger.

composer require "darkaonline/l5-swagger:~9.0"

Pass 2: Ikkonfigura Swagger

Wara l-installazzjoni, għandek bżonn tippubblika d- Swagger dokumentazzjoni fid- public direttorju tal Laravel -applikazzjoni tiegħek. Tista' tagħmel dan billi tmexxi Artisan kmandi:

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

Imbagħad, trid teditja l-fajl tal-konfigurazzjoni config/l5-swagger.php biex tikkonfigura Swagger għall-applikazzjoni tiegħek, inkluż li tispeċifika l-post fejn id-dokumentazzjoni se tiġi ppubblikata.

Pass 3: Uża Annotations

Uża annotations biex tiddeskrivi d-dokumentazzjoni tar-Rotot tiegħek fl Laravel -applikazzjoni tiegħek. Dawn annotations jintużaw minn Swagger biex jiġġeneraw awtomatikament id-dokumentazzjoni tal-API. Pereżempju:

/**  
 * @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 cách mà truy cậng v URL tương v 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 Rotta 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ồvồn hồ

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.