Using JSON:API for multilingual entitiesfor Drupal 8 , 9 , 10 , and 11

In this lesson, we expand on our previous exploration of APIs by introducing techniques to handle multilingual content with JSON:API in Drupal. Multilingual capabilities are crucial for delivering localized content in today's global digital landscape, and mastering this setup will ensure your site reaches diverse audiences effectively.

Understanding Multilingual Support in Drupal

Drupal’s robust multilingual system allows you to create and manage content in multiple languages. This is achieved through a combination of language configuration, content translation, and interface translation.

To fully leverage Drupal’s multilingual features, ensure the following modules are enabled:

• Language: Defines the languages available on your site.
• Content Translation: Provides tools to translate content entities into different languages.
• Interface Translation: Manages translations for built-in interface strings.

Setting Up Multilingual JSON:API Endpoints

Once your site is prepared for multilingual support, the JSON:API module automatically adapts to provide language-specific endpoints. Let's dive into the key configurations:

Step 1: Enabling Multilingual Modules

Begin by enabling the necessary multilingual modules with Drush:

drush en language content_translation interface_translation -y

With these modules activated, you can configure your site to support various languages via Configuration > Regional and language > Languages.

Step 2: Configure Content Translation

Go to Configuration > Regional and language > Content translation to select which content types and fields you want to translate. Enable translations for the necessary content types (e.g., Articles, Pages).

Step 3: Accessing Multilingual JSON:API Endpoints

JSON:API provides endpoints for each available language. For example, to access a 'node' in French:

GET /jsonapi/node/article?filter[langcode]=fr

This query retrieves French-translated articles, ensuring your client applications cater to linguistic preferences.

Creating and Updating Multilingual Content

When you need to manage multilingual content through the API, you must specify the language code during creation or update requests:

Example: Creating a Multilingual Node

Here's an example of creating an article in Spanish:

POST /jsonapi/node/article
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "node--article",
    "attributes": {
      "title": "Título de ejemplo",
      "langcode": "es"
    }
  }
}

Ensure that 'langcode' is defined to specify the language of the new entry.

Handling Language Negotiation

Drupal's language negotiation system determines how the appropriate language is selected for content display. Configure negotiation methods under Configuration > Regional and language > Language negotiation. This configuration can be based on user preferences, browser settings, or URL settings.

Best Practices for Multilingual JSON:API Usage

Conclusion and What’s Next?

By leveraging JSON:API to manage multilingual entities, your headless Drupal application can provide seamless support for global audiences. Tailoring content delivery to linguistic preferences not only enhances user experience but also broadens your site’s accessibility.

In our following lesson, we'll tackle "Setting Up Language Prefixes or Domains for APIs", exploring configurations that further optimize multilingual functionality in headless deployments.