ApiPlatform/Symfony - 为资源生成路径

Question

我喜欢为 APiPlatform 资源生成 uri，这对我来说似乎很初级，但我似乎不知道怎么做。这就是我想要完成的：

鉴于下面的资源定义，我想根据资源类名称、操作类型和操作名称获取 url。

/**
 * @ApiResource(
 *     itemOperations={"GET"},
 *     collectionOperations={"GET"}
 * )
 */
class Customer
{
    // ... 
}

$path = $someApiPlatformService->getOperationPath(Customer::class, ApiPlatform\Core\Api\OperationType::COLLECTION, 'GET');

路径的预期值为/api/customers。

$itemId = 'someid';
$path = $someApiPlatformService->getOperationPath(Customer::class, ApiPlatform\Core\Api\OperationType::ITEM, 'GET', $itemId);

路径的预期值为/api/customers/someid。

Answer 1

关于网址生成

您的问题主要由 IriConverterInterface::getIriFromResourceClass() 方法处理。这是将 URL 转换为实体和将实体转换为 URL 的 api 平台核心服务。

但是，它不使用操作名称，因为正如 here 解释的那样：

默认情况下，API Platform 使用 itemOperations 中定义的第一个 GET 操作生成项目的 IRI，并使用 collectionOperations 中定义的第一个 GET 操作生成集合的 IRI

部分解决方案

既然 IriConverterInterface 还不够，你还需要

1. 计算你的路由名称，例如与内部（即禁止，我现在不知道使用什么服务，但我猜它是路由命名空间中的一个接口）RouteNameGenerator::generate(),
2. 然后将其传递给 UrlGeneratorInterface::generate() 方法，正如 Symfony here 所解释的那样

$resourceNameAsArray = explode('\\', Customer::class);
$resourceShortName = $resourceNameAsArray[count($resourceNameAsArray) -1];
$routeName = ApiPlatform\Core\Bridge\Symfony\Routing\RouteNameGenerator::generate('GET', $resourceShortName, ApiPlatform\Core\Api\OperationType::COLLECTION);
$path = $urlGenerator->generate($routeName);