标签: api-platform.com

我已经使用 ApiPlatform 成功为我的系统构建了一个 API。感谢开发人员，这是一个出色的系统。我可以以 JSON-LD 格式向它发送请求，它也以 JSON-LD 格式返回响应。

我了解使用 JSON-LD 的好处，但我觉得我错过了一大块拼图。如何在我基于 Symfony 的 PHP 客户端（使用 API）中使用嵌入式 JSON-LD 上下文反序列化为 PHP 对象。

假设我的 API 有以下响应

{
  "@context": "/contexts/CallbackRequest",
  "@id": "/callback-requests/72",
  "@type": "CallbackRequest",
  "id": 72,
  "created": "2017-09-22T08:07:25+02:00",
  "customer": {
    "@id": "/customers/13",
    "@type": "Customer",
    "id": 13,
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "joe@bloggs.com",
    "mobilePhone": "123456789"
  }
}

现在，由于 JSON-LD @context 和 @type 数据，这里有足够的信息可以反序列化为CallbackRequest具有嵌套对象的2 个 PHP 对象。Customer

我已经编写了自己的反规范化器，但我必须告诉序列化器我想首先反序列化为哪种对象，但如果不首先对其进行规范化，我无法从 JSON-LD 中提取它。

我进行了很多搜索，寻找为 Symfony 序列化器制作 JSON-LD 规范化器/反规范化器的人，但什么也没找到（除了 API 平台包本身内的此功能）。

任何人都可以向我提供任何指针，无论是我可以实现的 JSON-LD 非规范化程序包，还是有关如何实现 Symfony 序列化程序以对 JSON-LD …

我正在尝试在 API 平台中实现自定义或过滤器。但由于某种原因，它没有加载。在我的配置下面找到。

这是我的过滤器：

<?php

namespace AppBundle\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use Doctrine\ORM\QueryBuilder;

use Doctrine\Common\Annotations\AnnotationReader;

final class SearchFilter extends AbstractFilter
{
    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
    {
    if ($property === 'search') {
        $this->logger->info('Search for: ' . $value);
    } else {
        return;
    }

    $reader = new AnnotationReader();
    $annotation = $reader->getClassAnnotation(new \ReflectionClass(new $resourceClass), \AppBundle\Filter\SearchAnnotation::class);

    if (!$annotation) {
        throw new \HttpInvalidParamException('No Search implemented.');
    }

    $parameterName = $queryNameGenerator->generateParameterName($property);
    $search = [];
    $mappedJoins = []; …

我想做的是：

• 从我的前端向 API 自定义 url 发送请求以激活用户帐户 (/account/activate/someTokenValue)
• 通过confirmationToken值检索用户表单数据库
• 激活用户帐户并将其保存到数据库
• 返回激活信息（或一些错误，例如令牌无效）

所以我定义了：

* @ApiResource(itemOperations={
 *     "get",
 *     "activate_account"={
 *         "method"="get",
 *         "path"="/account/activate/{confirmationToken}",
 *         "controller"=UserActivate::class
 *     }
 * })
 */

在我的User实体类中有一个UserActivate控制器，并由控制器UserActivateHandler调用UserActivate。我已将ApiProperty identifierID设置false为 to 和confirmationTokento true。

   /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     * @ApiProperty(identifier=false)
     *
     */
    private $id;

    /**
      * 
      * @ORM\Column(type="string", nullable=true)
      * @ApiProperty(identifier=true)
      */
    protected $confirmationToken;

但是API Platform仍然需要ID并且它似乎没有看到confirmationToken参数。

基本上我的问题是，在这种情况下，我如何检索对象confirmationToken？

我正在寻找一种解决方案来根据为空的参数（用户）恢复 get 中的数据：

    {
  "@context": "\/api\/contexts\/ShippingCost",
  "@id": "\/api\/shipping_costs",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "\/api\/shipping_costs\/1",
      "@type": "ShippingCost",
      "id": 1,
      "minWeight": 0,
      "maxWeight": 251,
      "france": 4.87,
      "domTom": 4.21,
      "aerial": 3.84,
      "zone": {
        "@id": "\/api\/zones\/1",
        "@type": "Zone",
        "id": 1,
        "name": "Guadeloupe",
        "TaxFOB": 35,
        "TaxSurete": 0.2,
        "TaxFuel": 0.77,
        "TaxGuerre": 0.24,
        "Lta": 0,
        "InfoDouane": 24,
        "CreditEnlevement": 0,
        "EntreposageCci": 0.4,
        "EntreposageCciMin": 15,
        "RemiseDoc": 43,
        "Surete": 0,
        "AvanceFond": 0,
        "Tid": 13,
        "Spia": 10,
        "InterTransite": 50
      },
      "user": null
    },
{
      "@id": "\/api\/shipping_costs\/162",
      "@type": "ShippingCost",
      "id": 162, …

我有这样的事情：

/**
 * @ORM/Entity
 * @ApiResource(
 *     itemOperations={
 *         "put_cancel": {
 *             "method": "PUT",
 *             "path": "/task/{id}/cancel",
 *             "messenger": "input",
 *             "input": CancelTaskCommand::class,
 *             "output": false
 *         },
 *     }
 * )
 */
class Foo {}

取消FooCommand.php

final class CancelFooCommand
{
    /**
     * @var string
     * @ApiProperty(
     *     identifier=true,
     * )
     */
    public string $id = '';

    /**
     * @var string
     * @ApiProperty(
     *     attributes={
     *         "openapi_context"={
     *           "type": "string"
     *         }
     *     }
     * )
     */
    public string $note …

我希望我的实体上的必填布尔字段具有默认值TRUE。我已将我的#api-platform属性定义如下。

#[ApiResource(
    attributes: ['security' => "is_granted('ROLE_USER')"],
    graphql: [
        'item_query' => ['security' => "is_granted('ROLE_USER') and object.owner == user"],
        'collection_query' => ['security' => "is_granted('ROLE_ADMIN')"],
        'delete' => ['security' => "is_granted('ROLE_DEVELOPER')"],
        'update' => ['security' => "is_granted('ROLE_DEVELOPER')"],
        'create' => [
            'defaults' => ['active' => TRUE],
            'security' => "is_granted('ROLE_DEVELOPER')"
        ]
    ]
)]

活动字段本身注释为

    /**
     * @ORM\Column(type="boolean", options={"default":true})
     */
    private $active;

这确实在数据库模式中设置了默认值，但是 GraphQL 突变似乎仍然要求在请求中提供此属性。当尝试创建一个不指定activeprop 的新实体时，我收到以下错误。

... Field value.active of required type Boolean! was not provided.