Työkalujen, kuten Swagger API-dokumentaation automaattisen luomisen, käyttö Laravel on kätevä tapa luoda ja ylläpitää API-dokumentaatiota. Swagger on avoimen lähdekoodin työkalu, jonka avulla voit kuvata, dokumentoida ja testata API-liittymiäsi. Swagger Voit käyttää Laravel API-dokumentaation luomiseen seuraavasti:
Vaihe 1: Asenna Swagger for Laravel
Asenna Swagger package for Laravel. Suosittu package tähän tarkoitukseen on darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
Vaihe 2: Määritä Swagger
Asennuksen jälkeen sinun on julkaistava dokumentaatio sovelluksesi Swagger hakemistoon. Voit tehdä tämän suorittamalla komennot: public Laravel Artisan
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
Tämän jälkeen sinun on muokattava konfiguraatiotiedostoa sovelluksesi config/l5-swagger.php määrittämistä Swagger varten, mukaan lukien sijainti, jossa dokumentaatio julkaistaan.
Vaihe 3: Käytä Annotations
Käytä annotations kuvataksesi reittiesi dokumentaatiota sovelluksessasi Laravel. Näitä annotations käytetään Swagger luomaan automaattisesti API-dokumentaatio. Esimerkiksi:
/**
* @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 truy cᛰngᛡứng 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 Reitti và thông tin chi tiết về cách sử dụng chúng, bao gồm các v.
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.