Swagger 生成 PHP restful API 接口文档

Swagger 是一种用于设计、构建、文档化和使用 RESTful Web 服务的工具集。它允许开发者使用简单的注释来描述 API 的各个方面，然后可以使用这些注释生成 API 的交互式文档、客户端库和服务器存根。

要使用 Swagger 生成 PHP RESTful API 接口文档，可以按照以下步骤进行操作：

1. 安装 Swagger：使用 Composer 安装 Swagger PHP 库。在终端中执行以下命令：

   composer require zircote/swagger-php

2. 创建 API 注释：在你的 PHP 文件中，使用 Swagger 注释来描述 API 的各个方面，例如请求方法、请求路径、参数、响应等。以下是一个示例注释：

   
   /**

• @OA\Get(
• path="/api/users",
• summary="获取用户列表",
• @OA\Response(
• response=200,
• description="成功",
• @OA\JsonContent(
• type="array",
• @OA\Items(ref="#/components/schemas/User")
• )
• ),
• @OA\Response(
• response=401,
• description="未授权"
• ),
• ) */

3. 生成文档：在终端中执行以下命令，生成 Swagger 文档：

   vendor/bin/openapi -o swagger.json app/Http/Controllers

   其中 app/Http/Controllers 是包含 API 控制器的目录。

4. 配置 Swagger UI：将 Swagger UI 的文件复制到你的项目中，并将生成的 Swagger 文档（swagger.json）复制到 Swagger UI 的目录中。

5. 启动 Swagger UI：在浏览器中打开 Swagger UI 的入口文件，即可看到生成的 API 文档。

通过以上步骤，你可以使用 Swagger 生成 PHP RESTful API 接口文档。你可以根据需要添加更多的注释来描述 API 的其他方面，例如请求体、请求头、认证等。