close

Laravel 다음을 사용하여 API 문서 자동 생성 Swagger

Swagger API 문서를 자동으로 생성하는 것과 같은 도구를 사용하면 Laravel API에 대한 문서를 만들고 유지 관리하는 편리한 방법입니다. Swagger API를 설명, 문서화 및 테스트하는 데 도움이 되는 오픈 소스 도구입니다. API 문서를 생성하기 위해 Swagger in을 사용하는 방법은 다음과 같습니다. Laravel

1단계: Swagger 설치 Laravel

작곡가를 사용하여 Swagger package for 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()  
 *      )  
 *)  
 */

유형 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ập URL tương ứng vớ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 Route 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ồi kỳ vọng.

Sử dụng Swagger trong Laravel giúp tạo tài liệu API tự động 및 tiết kiệm thời gian trong việc tạo và duy trì tài liệu.