Extending JSON-LD AND Hydra Contexts


JSON-LD screencast
Watch the JSON-LD screencast
API Platform provides the possibility to extend the JSON-LD context of properties. This allows you to describe JSON-LD-typed values, inverse properties using the `@reverse` keyword and you can even overwrite the `@id` property this way. Everything you define within the following annotation will be passed to the context. This provides a generic way to extend the context.

JSON-LD スクリーンキャストを見るAPI プラットフォームは、プロパティの JSON-LD コンテキストを拡張する可能性を提供します。これにより、`@reverse` キーワードを使用して JSON-LD 型の値、逆プロパティを記述することができ、この方法で `@id` プロパティを上書きすることさえできます。次の注釈内で定義するものはすべて、コンテキストに渡されます。これにより、コンテキストを拡張する一般的な方法が提供されます。

// api/src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;

#[ApiResource(types: ['https://schema.org/Book'])]
class Book
    // ...

        types: ['https://schema.org/name'],
        jsonldContext: [
            '@id' => 'http://yourcustomid.com',
            '@type' => 'http://www.w3.org/2001/XMLSchema#string',
            'someProperty' => [
                'a' => 'textA',
                'b' => 'textB'
    public $name;

    // ...
The generated context will now have your custom attributes set: `GET /contexts/Book`
  "@context": {
    "@vocab": "http://example.com/apidoc#",
    "hydra": "http://www.w3.org/ns/hydra/core#",
    "name": {
      "@id": "http://yourcustomid.com",
      "@type": "http://www.w3.org/2001/XMLSchema#string",
      "someProperty": {
        "a": "textA",
        "b": "textB"
Note that you do not have to provide the `@id` attribute. If you do not provide an `@id` attribute, the value from `iri` will be used. ## Hydra

Hydra screencast
Watch the Hydra screencast

Hydra のスクリーンキャストを見る

It's also possible to replace the Hydra context used by the documentation generator: [codeSelector]
// api/src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;

#[ApiResource(operations: [
  new Get(hydraContext: ['foo' => 'bar'])
class Book
# api/config/api_platform/resources.yaml
            hydraContext: { foo: 'bar' }
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->

<resources xmlns="https://api-platform.com/schema/metadata/resources-3.0"
    <resource class="App\Entity\Book">
            <operation class="ApiPlatform\Metadata\Get">              
                        <value name="foo">bar</value>