• Base Format
• HTTP Verbs
• URI
• Media Type (aka MIME type)

• http://drupal.org/project/services
• Endpoint concept with custom URL paths
• Caters for RPC and SOAP also
• Uses drupal_form_submit() for write operations
• Only covers hard coded entities like nodes, comments, users
• Explicit authentication info hooks.
• No hypermedia controls

• RESTWS http://drupal.org/project/restws
  • Relies on Entity API and metadata about entities
  • No endpoints: uses /node/1.json or /node/1.xml
  • No configuration: exposes any entity type out of the box
  • Access control on top of Entity API and Field API
  • Standard user authentication over session cookies or HTTP Basic Auth submodule
• Services Entity API http://drupal.org/project/services_entity
  • Combines approaches from Services and RESTWS
  • Configurable endpoints + Entity API for data management

• RESTful Web Services (REST module)
• Serialization module
• HAL module
• HTTP Basic Authentication module

• A resource is the object of interest. Example: the node resource
• An operation is an action to read or manipulate a resource.

We try to fix the paths to /node/1 at the code sprint on Friday!

• New Entity API with field metadata
• We know all properties and fields an entity has
• REST API support can be enabled for any content entity known to the system
• One derivative plugin for each entity type
• Access control on the entity level
• Access control on the field level

• Authentication is not handled by REST module
• AuthenticationProviderInterface in Drupal core
• Pluggable authentication providers:
  • Standard Drupal session cookie (Drupal core)
  • Basic HTTP Authentication (Drupal core)
  • OAuth (Contrib)
• Extra user permissions to authorize web service operations
• Additional access control in the resource plugin itself (example: entity and field access in the entity plugin)

• https://drupal.org/documentation/modules/rest
• Drupal 8 installation

  drush si --account-name=klausi --account-pass=secret \
  --site-name=drupal-8.localhost

• Serialization module (serialization)
• RESTful Web Services module (rest)
• HAL (Hypertext Application Language) module (hal)
• HTTP Basic Authentication module (basic_auth)

• drush en rest hal basic_auth--yes

• Copy all files in active config to the config staging directory

• cp sites/default/files/config_SNJe.../active/* \
  sites/default/files/config_SNJe.../staging/

• Edit rest.settings.yml in the config staging directory

• resources:
    'entity:node':        # We just enable the node resource alone.
      GET:                # Enable HTTP GET requests.
        supported_formats:
          - hal_json      # Only the HAL format is enabled.
        supported_auth:
          - http_basic    # Only HTTP Basic auth is enabled.

• Sync the configuration at admin/config/development/sync
• Clear caches

• drush cc all # UI: /admin/config/development/performance

• Go to /admin/people/permissions#module-rest and grant "Access GET on Content resource" to the anonymous user role.
• Note: node and field access still applies on top of that.

• drush role-add-perm anonymous 'restful get entity:node'

• Create a node at /node/add/page

• With cURL from the command line

• curl -H "Accept: application/hal+json" --request GET \
  http://drupal-8.localhost/entity/node/1

• With cURL from PHP

• $ch = curl_init();
  curl_setopt_array($ch, array(
    CURLOPT_URL => 'http://drupal-8.localhost/entity/node/1',
    CURLOPT_HTTPHEADER => array('Accept: application/hal+json'),
    CURLOPT_RETURNTRANSFER => TRUE,
  ));
  $response = json_decode(curl_exec($ch));
  print_r($response);

use Guzzle\Http\Client;

$client = new Client('http://drupal-8.localhost');
// If in a Drupal environment use the HTTP client service.
$client = Drupal::httpClient()->setBaseUrl('http://drupal-8.localhost');

$request = $client->get('entity/node/1');
$request->addHeader('Accept', 'application/hal+json');
$response = $request->send()->json();
print_r($response);

{
    "nid": [
        {
            "value": "1"
        }
    ],
    "uuid": [
        {
            "value": "f11b6d96-5709-4779-815c-9266f79b21c7"
        }
    ],
    "vid": [
        {
            "value": "1"
        }
    ],
    "type": [
        {
            "value": "page"
        }
    ],
    "langcode": [
        {
            "value": "en"
        }
    ],
    "title": [
        {
            "value": "Rest"
        }
    ],
    "_embedded": {
        "http://localhost/d8ser/rest/relation/node/page/uid": [
            {
                "_links": {
                    "self": {
                        "href": "http://localhost/d8ser/user/1"
                    },
                    "type": {
                        "href": "http://localhost/d8ser/rest/type/user/user"
                    }
                }
            }
        ],
        "http://localhost/d8ser/rest/relation/node/page/revision_uid": [
            {
                "_links": {
                    "self": {
                        "href": "http://localhost/d8ser/user/1"
                    },
                    "type": {
                        "href": "http://localhost/d8ser/rest/type/user/user"
                    }
                }
            }
        ]
    },
    "status": [
        {
            "value": "1"
        }
    ],
    "created": [
        {
            "value": "1372512896"
        }
    ],
    "changed": [
        {
            "value": "1372512901"
        }
    ],
    "comment": [
        {
            "value": "1"
        }
    ],
    "promote": [
        {
            "value": "0"
        }
    ],
    "sticky": [
        {
            "value": "0"
        }
    ],
    "tnid": [
        {
            "value": "0"
        }
    ],
    "translate": [
        {
            "value": "0"
        }
    ],
    "revision_timestamp": [
        {
            "value": "1372512901"
        }
    ],
    "log": [
        {
            "value": ""
        }
    ]
}

• Views is a configurable query builder in Drupal 8 core
• Display plugin that renders Views data with Serializer
• Comparable to Views Datasource in Drupal 7 http://drupal.org/project/views_datasource
• Support for outputting whole entities
• Show only selected fields for one entity item

• Edit rest.settings.yml in the config staging directory and import it as usual:

• resources:
    'entity:node':
      GET:
        supported_formats:
          - hal_json
        supported_auth:
          - http_basic
      POST:
        supported_formats:
          - hal_json
        supported_auth:
          - http_basic

• Grant the "Access POST on Content resource" to the administrator user role. Clear chaches!

• With cURL from the command line

• curl --include --request POST --user klausi:secret \
  --header 'Content-type: application/hal+json' \
  http://drupal-8.localhost/entity/node --data-binary \
  '{"_links":{"type":{"href":"http://drupal-8.localhost/rest/type/node/page"}}, \
  "title":[{"value":"test title"}]}'

$node = array(
  '_links' => array(
    'type' => array(
      'href' => 'http://drupal-8.localhost/rest/type/node/page'
    )
  ),
  'title' => array(0 => array('value' => 'New node title')),
);
$data = json_encode($node);
$ch = curl_init();
curl_setopt_array($ch, array(
  CURLOPT_URL => 'http://drupal-8.localhost/entity/node',
  CURLOPT_HTTPHEADER => array('Content-type: application/hal+json'),
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
  CURLOPT_USERPWD => 'klausi:secret',
));
curl_exec($ch);

$node = array(
  '_links' => array(
    'type' => array(
      'href' => 'http://drupal-8.localhost/rest/type/node/page'
    )
  ),
  'title' => array(0 => array('value' => 'New node title')),
);
$data = json_encode($node);

$client->post('entity/node', array(
    'Content-type' => 'application/hal+json',
  ), $data)
  // Username and password for HTTP Basic Authentication.
  ->setAuth('klausi', 'secret')
  ->send();

• Separation of data handling and serialization
• Classes where specially named methods correspond to HTTP methods
• One entity plugin with derivatives for all entity types
• Contributed modules can easily override/extend/provide plugins

GET http://example.com/dblog/1

/**
 * @Plugin(id = "dblog")
 */
class DBLogResource extends ResourceBase {
  public function get($id = NULL) {
    if ($id) {
      $record = db_query("SELECT * FROM {watchdog} WHERE wid = :wid",
        array(':wid' => $id))
        ->fetchAssoc();
      if (!empty($record)) {
        return new ResourceResponse($record);
      }
}}}
      

GET http://example.com/dblog/1

/**
 * @Plugin(id = "dblog")
 */
class DBLogResource extends ResourceBase {
  public function get($id = NULL) {
    if ($id) {
      $record = db_query("SELECT * FROM {watchdog} WHERE wid = :wid",
        array(':wid' => $id))
        ->fetchAssoc();
      if (!empty($record)) {
        return new ResourceResponse($record);
      }
}}}
      

GET http://example.com/dblog/1

/**
 * @Plugin(id = "dblog")
 */
class DBLogResource extends ResourceBase {
  public function get($id = NULL) {
    if ($id) {
      $record = db_query("SELECT * FROM {watchdog} WHERE wid = :wid",
        array(':wid' => $id))
        ->fetchAssoc();
      if (!empty($record)) {
        return new ResourceResponse($record);
      }
}}}
      

GET http://example.com/dblog/1

/**
 * @Plugin(id = "dblog")
 */
class DBLogResource extends ResourceBase {
  public function get($id = NULL) {
    if ($id) {
      $record = db_query("SELECT * FROM {watchdog} WHERE wid = :wid",
        array(':wid' => $id))
        ->fetchAssoc();
      if (!empty($record)) {
        return new ResourceResponse($record);
      }
}}}
      

GET http://example.com/dblog/1 Accept: application/hal+json

{
  "wid": "1",
  "uid": "0",
  "type": "system",
  "message": "%module module installed.",
  "variables": "a:1:{s:7:\"%module\";s:5:\"dblog\";}",
  "severity": "6",
  "link": "",
  "location": "http://drupal-8.localhost/core/install.php?langcode=en&profile=standard&id=1&op=do_nojs&op=do",
  "referer": "http://drupal-8.localhost/core/install.php?langcode=en&profile=standard&op=start&id=1",
  "hostname": "127.0.0.1",
  "timestamp": "1367615996"
}
      

GET http://example.com/dblog/1 Accept: application/xml

<?xml version="1.0"?>
<response>
  <wid>1</wid>
  <uid>0</uid>
  <type>system</type>
  <message>%module module installed.</message>
  <variables>a:1:{s:7:"%module";s:5:"dblog";}</variables>
  <severity>6</severity>
  <link></link>
  <location>
  <![CDATA[http://drupal-8.localhost/core/install.php?langcode=en&profile=standard&id=1&op=do_nojs&op=do]]>
  </location>
  <referer>
  <![CDATA[http://drupal-8.localhost/core/install.php?langcode=en&profile=standard&op=start&id=1]]>
  </referer>
  <hostname>127.0.0.1</hostname>
  <timestamp>1367615996</timestamp>
</response>
      

• JSON
• XML (kinda)
• Hypertext Application Language (HAL) JSON

$cancel_url = $base . '/slots/' . $appt['id'] . '/appointment';

$cancel_url = $appt['http://med.org/rels/cancel']['uri'];

• Entity reference, etc
• Entity management links?
• Views pagination?