如何在TP框架中集成Swagger

要在ThinkPHP（TP）框架中集成Swagger，你可以使用第三方庫，例如zircote/swagger-php和darkaonline/l5-swagger。下面是一個簡單的步驟來實現這個目標：

1. 安裝zircote/swagger-php: 通過Composer安裝zircote/swagger-php庫。打開命令行或終端，然后運行以下命令：

   composer require zircote/swagger-php
   

2. 安裝 darkaonline/l5-swagger: 通過Composer安裝darkaonline/l5-swagger庫。在命令行或終端中運行以下命令：

   composer require "darkaonline/l5-swagger"
   

3. 發布 Swagger 配置文件和資源文件: 在命令行或終端中運行以下命令：

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

   這將生成config/l5-swagger.php配置文件和public/vendor/l5-swagger目錄。

4. 創建注解文件: 在你的項目中為每個API創建注解文件。例如，在app/Http/Controllers/Api目錄下為每個控制器創建一個注解文件。

   示例注解文件：

   /**
    * @OA\Info(
    *      version="1.0.0",
    *      title="Example API",
    *      description="API description...",
    *      @OA\Contact(
    *          email="your@email.com"
    *      )
    * )
    *
    * @OA\Server(
    *      url=L5_SWAGGER_CONST_HOST,
    *      description="L5 Swagger Server"
    * )
    *
    */
   

5. 添加注解到控制器: 在控制器中添加適當的Swagger注解。例如：

   /**
    * @OA\Get(
    *      path="/api/example",
    *      operationId="getExample",
    *      tags={"Example"},
    *      summary="獲取示例數據",
    *      description="返回示例數據",
    *      @OA\Response(
    *          response=200,
    *          description="successful operation",
    *          @OA\JsonContent(ref="#/components/schemas/Example")
    *       ),
    *      @OA\Response(response=400, description="Bad request"),
    *      security={
    *          {"api_key": {}}
    *      }
    * )
    */
   

6. 生成Swagger文檔: 在命令行或終端中運行以下命令：

   php artisan l5-swagger:generate
   

   這將生成Swagger JSON和YAML文件。默認情況下，它們位于storage/api-docs目錄中。

7. 訪問Swagger UI: 在Web瀏覽器中訪問Swagger UI。默認情況下，它應該位于http://your-domain.com/api/documentation。

現在你已經在ThinkPHP（TP）框架中集成了Swagger。你可以查看和測試你的API。