friendsoftypo3/headless

This extension provides way to output content from TYPO3 in JSON format.

v4.5.0 2024-11-04 16:19 UTC

Requires

• ext-json: *
• typo3/cms-core: ^12.4 || ^13.4
• typo3/cms-install: ^12.4 || ^13.4

Requires (Dev)

• ergebnis/composer-normalize: ^2.43
• friendsofphp/php-cs-fixer: ^v3
• helmich/typo3-typoscript-lint: ^v3
• justinrainbow/json-schema: ^5
• php-coveralls/php-coveralls: ^2
• phpspec/prophecy-phpunit: ^2
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.12
• phpunit/phpcov: ^8 || ^9 || ^10
• saschaegerer/phpstan-typo3: ^1.1
• seld/jsonlint: ^1.11
• symfony/yaml: ^6.1 || ^7.1
• typo3/cms-form: ^12.4 || ^13.3
• typo3/coding-standards: ^0.8
• typo3/testing-framework: ^8.0

Conflicts

• typo3/cms-core: <12.4.21

GPL-2.0-or-later

• Tymoteusz Motylewski
• Łukasz Uznański
• TYPO3 PWA Initiative

• json
• headless
• typo3
• pwa

README

Headless allows you to render JSON from TYPO3 content. You can customize output by changing types, names and nesting of fields.

This extension provides backend part (JSON API) for TYPO3 PWA solution. Second part is a JavaScript application nuxt-typo3 which consumes JSON API and renders the content using Vue.js and Nuxt. See frontend documentation here: https://typo3-headless.github.io/nuxt-typo3/

If you have any questions just drop a line in #initiative-headless-pwa Slack channel.

Features

• JSON API for content elements
• JSON API for page and meta data
• JSON API for navigation, layouts
• taking into account all language and translation configuration (e.g. fallback)
• easily extendable with custom fields or custom content elements
• custom data processors directly for headless usage
• support for EXT:form
• support for EXT:felogin
• support for EXT:redirects
• support for EXT:seo

Additional extensions and integrations

• headless support for EXT:news headless_news
• headless support for EXT:solr headless_solr
• headless support for EXT:powermail headless_powermail
• headless support for EXT:gridelements headless_gridelements
• small tools/tweaks for local headless development headless_dev_tools
• headless support for EXT:container headless-container-support and headless_container

Requirements and compatibility

Quickstart / Demo

If you want to take a look at working demo including frontend, backend and demo data, use our DDEV based demo project here: https://github.com/TYPO3-Initiatives/pwa-demo

Installation

Install extension using composer

composer require friendsoftypo3/headless

Documentation

Extension documentation

How to start with TYPO3 Headless video tutorial

Whether you are a developer, content manager, or a tech enthusiast, this tutorial is tailored to provide a comprehensive introduction to TYPO3 Headless, helping you to get started on your journey with confidence.

Configuration

Since versions: 4.2 | 3.5 Flag headless is required to configure in site configuration!

This flag instructs how EXT:headless should behave in multisite instance.

For each site you can set in which mode site is operated (standard aka HTML response, headless, or mixed mode).

You can set headless flag manually in yaml file or via site configuration in the backend:

'headless': 0|1|2

Possible values:

While the legacy flag (true|false) is still recognized, transitioning to the integer notation is recommended.

• 0 (formerly: false) = headless mode is deactivated for the site within the TYPO3 instance. Default value!
• 1 (formerly: true) = headless mode is fully activated for the site within the TYPO3 instance.
• 2 = mixed mode headless is activated (both fluid & json API are accessible within a single site in the TYPO3 instance).

Configuration steps

For a chosen site in TYPO3, follow these steps:

To enable Headless Mode:

• In the typoscript template for the site, load the "Headless" setup file.
• Set headless flag to a value of 1 in the site configuration file or configure the flag via editor in the Site's management backend.

To enable Mixed Mode:

• In the typoscript template for the site, load the "Headless - Mixed mode JSON response" setup file instead of the default headless one.
• Set headless flag to a value of 2 in the site configuration file or configure the flag via editor in the Site's management backend.

The mixed mode flag (value of 2) instructs the EXT:headless extension to additionally check for the Accept header with a value of application/json when processing requests to the particular site in the TYPO3 instance.

• In cases where a request lacks the Accept header or Accept has a different value than application/json, TYPO3 will respond with HTML content (standard TYPO3's response).
• In cases where a request's header Accept matches the value of application/json, TYPO3 will respond with a JSON response.

JSON Content Object

In headless extension we implemented new JSON Content Object, which allows you to specify what fields you want to output, and how they will look. First, let's take a look at simple example

lib.page = JSON
lib.page {
  fields {
    header = TEXT
    header {
      field = header
    }
  }
}

Output

{
    "header" : "headerFieldValue"
}

in addition, keyword fields allow you to nest multiple times fields in json, e.g.

lib.page = JSON
lib.page {
  fields {
    data {
      fields {
        foo = TEXT
        foo {
          field = bar
        }

        foo1 = TEXT
        foo1 {
          field = bar1
        }
      }
    }
  }
}

Output

{
    "data": [
        {
            "foo": "bar",
            "foo1": "bar1"
        }
    ]
}

INT, FLOAT & BOOL Content Objects for use in JSON Content Object

We introduce new simple content objects to improve JSON API response for frontend developers. We can set correct property types, so frontend does not have to deal with string values for fields with numeric values or field that should be true/false.

lib.page = JSON
lib.page {
  fields {
    data {
      fields {
        foo = INT
        foo {
          # db value of foo_field = 1
          field = foo_field
        }
        bar = BOOL
        bar {
          # db value of bar_field = 0
          field = bar_field
        }
      }
    }
  }
}

Output

{
    "data": [
        {
            "foo": 1,
            "bar": false
        }
    ]
}

Customizing

You can override every field in output using typoscript. This extension allows you to use standard typoscript objects such as TEXT, COA, CASE.

Example page response ⬇️

DataProcessing

You can use Data Processors just like in FLUIDTEMPLATE Content Object, e.g.

lib.languages = JSON
lib.languages {
  dataProcessing {
    10 = TYPO3\CMS\Frontend\DataProcessing\LanguageMenuProcessor
    10 {
      languages = auto
      as = languages
    }
  }
}

Built in data processors

We provide multiple data processors for headless rendering purposes.

DatabaseQueryProcessor

Used for fetching records from the database.

FilesProcessor

This processor should be used to process files (standard or media files).

Also, it allows you to process images. See docs chapter: Images for details.

GalleryProcessor

Should be used along with FilesProcessor (chained). Used for processing mutliple media files.

MenuProcessor

Used for navigation. Works just like standard menu processor.

FlexFormProcessor

Used for processing flexforms.

RootSitesProcessor

Render your all headless sites configuration for your frontend application.

Contributing

Development

Development for this extension is happening as part of the TYPO3 PWA initiative, see https://typo3.org/community/teams/typo3-development/initiatives/pwa/ If you have any questions, join the #initiative-headless-pwa Slack channel.

Credits

A special thanks goes to macopedia.com company, which is sponsoring development of this solution.