RELAXed Web Services

This module provides a generic RESTful API for all content entities. It extends the core REST API with better support for translations, revisions, file attachments, UUID references etc.

The API is based on the CouchDB replication protocol and the Multiversion module handle the underlying entity storage to support complex bi-directional content replication scenarios across a network of sites or environments. The API also provides the ability for clients to subscribe to real-time change notifications.

Screencast

https://www.youtube.com/watch?v=ibBX2cHdhu8

Installation

If you have not installed RELAXed Web Services with composer you will need to run composer require relaxedws/replicator:dev-master in your Drupal root directory, or use Composer Manager, to make sure all dependencies are added.
More information

Uninstall

To unistall the module it's recommended to use drush relun command.

Use Cases

Decoupled, offline-capable front-end sites

Since the API is heavily inspired by CouchDB it can be used to create "offline-first" apps or websites with compatible frontend libraries such as PouchDB or Hood.ie.

At DrupalCon New Orleans this session will be presented on the topic: https://events.drupal.org/neworleans2016/sessions/offline-capable-decoup...

Content Staging

Visit drupaldeploy.org to learn more about the suite that this module is part of.

Contrib Dependencies

Recommended Modules

Presentations

Compatibility

  • Starting with 8.x-1.0-beta1 RELAXed Web Services is not compatible with Drupal 8.2.x and older. For Drupal <= 8.2.x use 8.x-1.0-alpha11.
  • Incompatible with the "Enforce clean and canonical URLs" setting in Redirect module

Project information

Releases