Symfony中如何管理API版本

在Symfony中管理API版本，可以通過以下幾種方法實現：

1. 使用路由版本控制：

在routes/api.yaml文件中，可以為每個版本的API定義單獨的路由。例如：

# api_v1.yaml
api_v1:
    path: /api/v1/{controller}/{action}
    defaults: { _controller: App\Controller\ApiV1\YourController }
    methods: [GET, POST, PUT, DELETE]

# api_v2.yaml
api_v2:
    path: /api/v2/{controller}/{action}
    defaults: { _controller: App\Controller\ApiV2\YourController }
    methods: [GET, POST, PUT, DELETE]

然后，根據需要激活不同的配置文件。

2. 使用命名空間：

為每個版本的API控制器創建一個命名空間。例如：

// src/Controller/ApiV1/YourController.php
namespace App\Controller\ApiV1;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class YourController extends AbstractController
{
    // ...
}

// src/Controller/ApiV2/YourController.php
namespace App\Controller\ApiV2;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class YourController extends AbstractController
{
    // ...
}

接下來，在路由文件中使用命名空間來引用控制器。

3. 使用請求頭中的自定義版本信息：

可以通過檢查請求頭中的自定義字段（例如API-Version）來確定請求的API版本。然后，根據該信息動態加載適當的控制器和邏輯。

首先，創建一個中間件來處理版本信息：

// src/Middleware/ApiVersionMiddleware.php
namespace App\Middleware;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\MiddlewareInterface;

class ApiVersionMiddleware implements MiddlewareInterface
{
    public function handle(Request $request, Closure $next)
    {
        $version = $request->headers->get('API-Version');

        if ($version && in_array($version, ['v1', 'v2'])) {
            $request->attributes->add(['api-version' => $version]);
        } else {
            return new Response('Invalid API version', 400);
        }

        return $next($request);
    }
}

接下來，在app/Kernel.php文件中注冊中間件：

protected $middlewareGroups = [
    'api' => [
        // ...
        \App\Middleware\ApiVersionMiddleware::class,
    ],
];

現在，可以在控制器中訪問請求的版本信息：

// src/Controller/YourController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class YourController extends AbstractController
{
    public function yourAction()
    {
        $version = $this->request->attributes->get('api-version');

        if ($version === 'v1') {
            // 處理v1版本的邏輯
        } elseif ($version === 'v2') {
            // 處理v2版本的邏輯
        }
    }
}

這些方法可以根據項目需求進行組合使用，以實現靈活的API版本管理。