新しいリソースの作成（POST）

このページでは、JSON:APIモジュールのさまざまなPOSTリクエストの例を示します。

POSTリクエストは新しいリソースを作成するために使用されます。変更が必要な場合は、PATCHを使用します。

JSON:API仕様（したがってJSON:APIモジュール）は、POSTリクエストごとに1つのリソースの作成のみをサポートします。Drupalの場合、これは（このモジュール単独では）1つのリクエストで複数のエンティティを作成することが不可能であることを意味します。これは、親エンティティと同時に参照エンティティを作成したい場合に必要になるかもしれません。JSON:APIはそのような動作をサポートできませんが、Subrequestsのようなモジュールがそういった要件に役立ちます。

作成操作の有効化

/admin/config/services/jsonapiにアクセスし、
「Accept all JSON:API create, read, update, and delete operations.（すべてのJSON:APIの作成、読み取り、更新、削除操作を受け入れる）」オプションをオンにします。

認証

通常、POSTリクエストには何らかの認証が使用されます。以下の例はすべて、指定されたコンテンツを作成するパーミッションを持つサイト内の既存ユーザーのユーザー名とパスワードを使用したBasic認証を使用しています。

HTTP Basic Authentication（basic_auth）モジュールを有効にし、APIユーザー（およびロール）のパーミッションを設定し、エンコードされたユーザー名とパスワードを「Authorization」リクエストヘッダーに設定します。

このページのヘッダーの例では、ユーザー名「api」とパスワード「api」のDrupalユーザーが必要です。

ヘッダー

適切なJSON:APIリクエストとレスポンスを得るには、次のヘッダーがすべてのPOSTリクエストで必須です。

• Accept: application/vnd.api+json
• Content-Type: application/vnd.api+json

例を機能させるには、次のヘッダーが必要です。

• Authorization: Basic YXBpOmFwaQ==

Curl

データがpayload.jsonファイルにあると仮定します。

curl \
    --user api:api \
    --header 'Accept: application/vnd.api+json' \
    --header 'Content-type: application/vnd.api+json' \
    --request POST http://drupal.d8/jsonapi/node/article \
    --data-binary @payload.json

基本的なPOSTリクエスト

URL： http://example.com/jsonapi/node/article

リクエストボディ

{
  "data": {
    "type": "node--article",
    "attributes": {
      "title": "My custom title",
      "body": {
        "value": "Custom value",
        "format": "plain_text"
      }
    }
  }
}

レスポンス

HTTP 201（作成済み）レスポンス。レスポンスボディには、作成されたエンティティのJSON:APIレスポンスが含まれます。

リレーションシップを含むPOSTリクエスト

URL： http://example.com/jsonapi/node/article

エンティティ参照フィールドは、attributesではなくrelationshipsとして設定する必要があります。これを行わないと、「The following relationship fields were provided as attributes」というエラーメッセージと、問題のあるフィールドのリストが表示されます。

idキーには、エンティティのIDではなくUUIDを含める必要があります。例： faba301b-bdf5-4658-abc1-e173b815984f。

リクエストボディ

{
  "data": {
    "type": "node--article",
    "attributes": {
      "title": "Article by admin",
      "body": {
        "value": "Custom value",
        "format": "plain_text"
      }
    },
    "relationships": {
      "uid": {
        "data": {
          "type": "user--user",
          "id": "{{UUID of user 1}}"
        }
      },
      "field_taxonomy_term_reference": {
        "data": {
          "type": "taxonomy_term--{{bundle}}",
          "id": "{{UUID of the term}}"
        }
      }
    }
  }
}

レスポンス

HTTP 201（作成済み）レスポンス。レスポンスボディには、作成されたエンティティのJSON:APIレスポンスが含まれます。

REST APIを使用したPOSTメソッド  

まず、RESTリソースを持つカスタムモジュールを作成し、/admin/config/services/restに移動して有効にします。

<?php

namespace Drupal\rest_examples\Plugin\rest\resource;

use Drupal\node\Entity\Node;
use Drupal\rest\Plugin\ResourceBase;
use Drupal\rest\ResourceResponse;
use Drupal\Core\Session\AccountProxyInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Provides a resource to post nodes.
 *
 * @RestResource(
 *   id = "rest_resource_post_example",
 *   label = @Translation("Rest Resource Post Example"),
 *   uri_paths = {
 *     "create" = "/rest/api/post/node-create"
 *   }
 * )
 */
class RestResourcePostExample extends ResourceBase {

  use StringTranslationTrait;

  /**
   * A current user instance.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * Constructs a Drupal\rest\Plugin\ResourceBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param array $serializer_formats
   *   The available serialization formats.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   A current user instance.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $serializer_formats, LoggerInterface $logger, AccountProxyInterface $current_user) {

    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);

    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->getParameter('serializer.formats'),
      $container->get('logger.factory')->get('rest_examples'),
      $container->get('current_user')
    );
  }

  /**
   * Responds to POST requests.
   *
   * Creates a new node.
   *
   * @param mixed $data
   *   Data to create the node.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\HttpException
   *   Throws exception expected.
   */
  public function post($data) {

    // Use current user after pass authentication to validate access.
    if (!$this->currentUser->hasPermission('administer site content')) {

      // Display the default access denied page.
      throw new AccessDeniedHttpException('Access Denied.');
    }

    foreach ($data as $key => $value) {

      $node = Node::create(
        [
          'type' => $value['nodetype'],
          'title' => $value['title'],
          'body' => [
            'summary' => '',
            'value' => $value['body'],
            'format' => 'full_html',
          ],
        ]
      );

      $node->enforceIsNew();
      $node->save();

      $this->logger->notice($this->t("Node with nid @nid saved!\n", ['@nid' => $node->id()]));

      $nodes[] = $node->id();

    }

    $message = $this->t("New Nodes Created with nids : @message", ['@message' => implode(",", $nodes)]);

    return new ResourceResponse($message, 200);

  }

}

ノードを作成するためのJSONサンプルデータ：

[
    {
        "nodetype": "article",
        "title": "Training",
        "body": "Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Vivamus vestibulum sagittis sapien. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.\n\nEtiam vel augue. Vestibulum rutrum rutrum neque. Aenean auctor gravida sem.\n\nPraesent id massa id nisl venenatis lacinia. Aenean sit amet justo. Morbi ut odio."
    },
    {
        "nodetype": "page",
        "title": "Team Building",
        "body": "Integer tincidunt ante vel ipsum. Praesent blandit lacinia erat. Vestibulum sed magna at nunc commodo placerat.\n\nPraesent blandit. Nam nulla. Integer pede justo, lacinia eget, tincidunt eget, tempus vel, pede.\n\nMorbi porttitor lorem id ligula. Suspendisse ornare consequat lectus. In est risus, auctor sed, tristique in, tempus sit amet, sem."
    },
    {
        "nodetype": "article",
        "title": "Services",
        "body": "Proin interdum mauris non ligula pellentesque ultrices. Phasellus id sapien in sapien iaculis congue. Vivamus metus arcu, adipiscing molestie, hendrerit at, vulputate vitae, nisl.\n\nAenean lectus. Pellentesque eget nunc. Donec quis orci eget orci vehicula condimentum.\n\nCurabitur in libero ut massa volutpat convallis. Morbi odio odio, elementum eu, interdum eu, tincidunt in, leo. Maecenas pulvinar lobortis est."
    },
    {
        "nodetype": "page",
        "title": "Product Management",
        "body": "Cras mi pede, malesuada in, imperdiet et, commodo vulputate, justo. In blandit ultrices enim. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.\n\nProin interdum mauris non ligula pellentesque ultrices. Phasellus id sapien in sapien iaculis congue. Vivamus metus arcu, adipiscing molestie, hendrerit at, vulputate vitae, nisl.\n\nAenean lectus. Pellentesque eget nunc. Donec quis orci eget orci vehicula condimentum."
    },
    {
        "nodetype": "article",
        "title": "Business Development",
        "body": "Nullam porttitor lacus at turpis. Donec posuere metus vitae ipsum. Aliquam non mauris.\n\nMorbi non lectus. Aliquam sit amet diam in magna bibendum imperdiet. Nullam orci pede, venenatis non, sodales sed, tincidunt eu, felis.\n\nFusce posuere felis sed lacus. Morbi sem mauris, laoreet ut, rhoncus aliquet, pulvinar sed, nisl. Nunc rhoncus dui vel sem."
    }
]

POSTリクエストを行うためのcurlコマンド：

curl \
    --user uname:password \
    --header 'Accept: application/json' \
    --header 'Content-type: application/json' \
    --request POST http://example.com/rest/api/post/node-create \
    --data-binary @post_data.json

Drupalドキュメントからの記事です。