Laravel 自动 生成API文档 Swagger

Swagger 使用自动生成 API 文档 等工具 Laravel 是创建和维护 API 文档的便捷方法。 Swagger 是一个开源工具,可帮助您描述、记录和测试 API。 以下是如何使用 Swagger in Laravel 生成 API 文档:

第 1 步: Swagger 安装 Laravel

使用 Composer 安装 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 您的应用程序,包括指定发布文档的位置。

第三步:使用 Annotations

用于 annotations 描述应用程序中的路由文档 Laravel。 这些 annotations 用于 Swagger 自动生成 API 文档。 例如:

/**  
 * @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ậ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 và tiết kiệm thời gian trong việc tạo và duy trì tài liệu。