rest-jsonapi

Drupal 11 REST & JSON:API Development

JSON:API (Recommended for Entity CRUD)

JSON:API is enabled by default. Endpoints follow the pattern:

/jsonapi/{entity_type_id}/{bundle_id}
/jsonapi/{entity_type_id}/{bundle_id}/{uuid}

Examples

GET    /jsonapi/node/article                    # List articles
GET    /jsonapi/node/article/{uuid}             # Get single article
POST   /jsonapi/node/article                    # Create article
PATCH  /jsonapi/node/article/{uuid}             # Update article
DELETE /jsonapi/node/article/{uuid}             # Delete article

Filtering & Sorting

/jsonapi/node/article?filter[status]=1
/jsonapi/node/article?sort=-created
/jsonapi/node/article?include=uid,field_tags
/jsonapi/node/article?fields[node--article]=title,body
/jsonapi/node/article?page[limit]=10&page[offset]=0

JSON:API Request Body (POST/PATCH)

{
  "data": {
    "type": "node--article",
    "attributes": {
      "title": "My Article",
      "body": {
        "value": "<p>Content</p>",
        "format": "basic_html"
      }
    },
    "relationships": {
      "uid": {
        "data": { "type": "user--user", "id": "USER_UUID" }
      }
    }
  }
}

Custom REST Resources

For non-entity data or complex business logic:

namespace Drupal\MODULE_NAME\Plugin\rest\resource;

use Drupal\rest\Plugin\ResourceBase;
use Drupal\rest\ResourceResponse;

#[RestResource(
  id: "my_resource",
  label: new TranslatableMarkup("My Resource"),
  uri_paths: [
    "canonical" => "/api/my-resource/{id}",
    "create" => "/api/my-resource",
  ]
)]
class MyResource extends ResourceBase {

  public function get(string $id): ResourceResponse {
    $data = ['id' => $id, 'message' => 'Hello'];
    $response = new ResourceResponse($data, 200);
    $response->addCacheableDependency(CacheableMetadata::createFromRenderArray([
      '#cache' => ['max-age' => 3600],
    ]));
    return $response;
  }

  public function post(array $data): ModifiedResourceResponse {
    // Validate and process $data
    return new ModifiedResourceResponse($result, 201);
  }
}