close

Ƙirƙirar Takardun API ta atomatik tare Laravel da Swagger

Amfani da kayan aikin kamar Swagger samar da takaddun API ta atomatik a cikin Laravel ita ce hanya mai dacewa don ƙirƙira da kula da takaddun don API ɗinku. Swagger kayan aiki ne na buɗaɗɗen tushe wanda ke taimaka muku bayyanawa, rubuta bayanai, da gwada APIs ɗin ku. Anan ga yadda zaku iya amfani Swagger dashi Laravel don samar da takaddun API:

Mataki 1: Shigar Swagger don Laravel

Yi amfani da mawaki don shigar da Swagger package na Laravel. Shahararren package don wannan dalili shine darkaonline/l5-swagger.

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

Mataki 2: Sanya Swagger

Bayan shigarwa, kuna buƙatar buga Swagger takaddun zuwa public kundin adireshin aikace-aikacen ku Laravel. Kuna iya yin haka ta hanyar gudanar da Artisan umarni:

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

Bayan haka, kuna buƙatar gyara fayil ɗin sanyi config/l5-swagger.php don daidaitawa Swagger don aikace-aikacenku, gami da ƙayyadaddun wurin da za a buga takaddun.

Mataki na 3: Yi amfani Annotations

Yi amfani da su annotations don siffanta takaddun hanyoyin hanyoyinku a cikin Laravel aikace-aikacenku. annotations Ana amfani da waɗannan Swagger don samar da takaddun API ta atomatik. Misali:

/**  
 * @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()  
 *      )  
 *)  
 */

Mataki na 4: Haƙiƙa API Swagger

Khi bạn đã cấu hình da kuma yadda za a yi amfani da su, da kuma truy cập tai liệu API don bincika URL ɗin URL. ã Swagger cấu hình trong tệp cấu hình. Bugu da kari, URL na iya samun damar http://your-app-url/api/documentation.

Swagger sẽ hiển thĩ tài liệu về các Route và thông tin chi tiết về cách sử ɗung chúng, bao gồm các thông số và phản hồi kỳ .

Yadda za a yi amfani da API Swagger don Laravel samun damar yin amfani da kayan aikin da aka yi amfani da su don samun damar yin amfani da su.