Symfony 4如何打印API所有端点？替代Symfony 2容器方式

嘿，这个问题我之前也碰到过！Symfony 4确实把直接访问容器的路子给收了，但用依赖注入的方式反而更符合它现在的设计理念，给你两个实用的实现方案：

这是最快捷的方式，利用Symfony的自动依赖注入就能搞定：

1. 先在你的控制器类里，通过构造函数注入RouterInterface：

use Symfony\Component\Routing\RouterInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class ApiIndexController extends AbstractController
{
    private $router;

    public function __construct(RouterInterface $router)
    {
        $this->router = $router;
    }

2. 然后在动作方法里获取路由集合，还能过滤出你的API专属路由（比如按/api前缀筛选，你可以根据自己的实际情况调整）：

public function index()
{
    // 获取系统所有路由
    $routeCollection = $this->router->getRouteCollection();
    
    // 过滤出API路由
    $apiRoutes = [];
    foreach ($routeCollection->all() as $routeName => $route) {
        $path = $route->getPath();
        if (strpos($path, '/api') === 0) {
            $apiRoutes[$routeName] = [
                'path' => $path,
                'allowed_methods' => $route->getMethods(),
                'controller' => $route->getDefault('_controller'),
            ];
        }
    }

    // 把路由数据传给Twig模板渲染成页面
    return $this->render('api/index.html.twig', [
        'api_routes' => $apiRoutes,
    ]);
}

3. 最后写个Twig模板来展示这些端点（放在templates/api/index.html.twig）：

<h1>API Endpoints Index</h1>
<div class="route-list">
    {% for routeName, route in api_routes %}
        <div class="route-item">
            <h3>{{ routeName }}</h3>
            <p><strong>Path:</strong> {{ route.path }}</p>
            <p><strong>Allowed Methods:</strong> {{ route.allowed_methods|join(', ') }}</p>
            <p><strong>Handled By:</strong> {{ route.controller }}</p>
        </div>
    {% endfor %}
</div>

如果你的API索引需要更复杂的逻辑（比如按模块分组、过滤特定路由、添加更多路由元信息），可以把路由收集逻辑封装成一个服务：

1. 创建服务类src/Service/ApiRouteCollector.php：

use Symfony\Component\Routing\RouterInterface;

class ApiRouteCollector
{
    private $router;

    public function __construct(RouterInterface $router)
    {
        $this->router = $router;
    }

    // 可以自定义前缀参数，灵活筛选不同前缀的API路由
    public function collectApiRoutes(string $prefix = '/api'): array
    {
        $routeCollection = $this->router->getRouteCollection();
        $apiRoutes = [];

        foreach ($routeCollection->all() as $routeName => $route) {
            if (strpos($route->getPath(), $prefix) === 0) {
                $apiRoutes[$routeName] = [
                    'path' => $route->getPath(),
                    'allowed_methods' => $route->getMethods(),
                    'requirements' => $route->getRequirements(),
                    'defaults' => $route->getDefaults(),
                ];
            }
        }

        return $apiRoutes;
    }
}

2. 在控制器里注入这个服务就行：

use App\Service\ApiRouteCollector;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class ApiIndexController extends AbstractController
{
    private $routeCollector;

    public function __construct(ApiRouteCollector $routeCollector)
    {
        $this->routeCollector = $routeCollector;
    }

    public function index()
    {
        // 调用服务获取API路由
        $apiRoutes = $this->routeCollector->collectApiRoutes();
        
        return $this->render('api/index.html.twig', [
            'api_routes' => $apiRoutes,
        ]);
    }
}

• 如果你的路由是用注解定义的（比如@Route），记得先清除缓存（php bin/console cache:clear）再测试，不然可能拿不到最新的路由信息。
• 要是想给路由加更多说明（比如接口描述、参数说明），可以在定义路由时通过defaults添加自定义参数，比如@Route("/api/users", defaults={"_description"="Get all users"})，然后在收集路由时把这个值也取出来。
• Symfony Flex下服务是自动配置的，不用手动在services.yaml里注册，除非你需要给服务加额外的参数或者标签。

内容的提问来源于stack exchange，提问作者RokDev