skqr/hateoas

GOintegro HATEOAS Lib

GOintegro / HATEOAS

, _(*1)

, _(*2)

This is a library that uses a Doctrine 2 entity map and a RAML API definition to conjure a HATEOAS API, following the JSON-API specification., _(*3)

You don't get scaffolds. You get a working API., _(*4)

You get a working API with features sweeter than a Bobcat's self-esteem., _(*5)

Features

Here's what I mean., _(*6)

• Flat, referenced JSON serialization.
  • Clear distinction between scalar fields and linked resources.
• Magic controllers.
  • Fetching resources, with support for:
  • Sparse fields;
  • Linked resources expansion;
  • Standarized filtering and sorting;
  • Pagination;
  • Resource metadata, such as facets in a search.
  • Altering resources, with support for:
  • Processing multiple actions in one request;
  • Request validation using JSON schema;
  • Entity validation using Symfony's validator;
  • Create, update, and delete out of the box;
  • Assign services to handle any of the above for specific resources.
• Translatable content out-of-the-box.
• Metadata caching, similar to that of Doctrine 2;
  • Redis,
  • Or Memcached.

Here's what you'll need., _(*7)

• A Doctrine 2 entity map;
• A RAML API definition;
• At least one Symfony 2 security voter.

Try it out

Check out the example app project, so you can feel the magic in your finger tips without much ado., _(*8)

Installation

Check out the Symfony 2 bundle for a full-stack framework implementation., _(*9)

Usage

Design your API in the RAML language following the JSON-API spec., _(*10)

Something like this example, which assumes you have an entity class with the short-name User., _(*11)

#%RAML 0.8
title: HATEOAS Inc. Example API
version: v1
baseUri: http://localhost:8000/api/{version}
mediaType: application/vnd.api+json
/users:
  get:
    description: Fetches all users.
    responses:
      200:
  post:
    description: Creates one or more users.
    responses:
      201:
  /{user-ids}:
    get:
      description: Fetches users by Id.
      responses:
        200:
    put:
      description: Updates one or more users by Id.
      responses:
        200:
    delete:
      description: Deletes one or more users by Id.
    /links:
      /{relationship}:
        get:
          description: Fetches the related resources.
          responses:
            200:
        post:
          description: Relates one or more resources.
          responses:
            201:
        put:
          description: Updates the relationship.
          responses:
            204:
        delete:
          description: Removes the relationship.
        /{relationship-ids}:
          delete:
            description: Removes to-many relationships by Id.

Have your entity implement the resource interface., _(*12)

The namespace isn't considered, only the short-name is used to match against the resources defined above., _(*13)

Voilà - you get the following for free., _(*14)

GET /users
GET /users/1
GET /users/1,2,3
GET /users/1/name
GET /users/1/linked/posts
GET /posts/1/linked/owner
GET /posts?owner=1
GET /posts?owner=1,2,3
GET /users?sort=name,-birth-date
GET /users?include=posts,posts.comments
GET /users?fields=name,email
GET /users?include=posts,posts.comments&fields[users]=name&fields[posts]=content
GET /users?page=1
GET /users?page=1&size=10

Any combination., _(*15)

You also get these., _(*16)

POST /users

PUT /users/1
PUT /users/1,2,3

DELETE /users/1
DELETE /users/1,2,3

And you get to link or unlink resources thus., _(*17)

POST /users/1/links/user-groups

PUT /users/1/links/user-groups

DELETE /users/1/links/user-groups
DELETE /users/1/links/user-groups/1
DELETE /users/1/links/user-groups/1,2,3

Sweet, right?, _(*18)

The resource_type must match the calculated type - for now. E.g. UserGroup, user-groups., _(*19)

Resources

But you need to have some control over what you expose, right? Got you covered., _(*20)

You can optionally define a class like this for your entity, and optionally define any of the properties and methods you will see within., _(*21)

entity->getType();
    }

    /**
     * We can use services if we implement the ContainerAwareInterface.
     * @return string
     */
    public function injectSomethingExtraordinary()
    {
        return $this->container->get('mystery_machine')->amaze();
    }
}
?>

Check out the unit tests for more details., _(*22)

JSON Schema

Requests that create or update resources have the content of their bodies validated against the schema defined in the RAML for that resource and method., _(*23)

Since bodies in JSON-API look pretty similar whether you are fetching, creating, or updating, you can use a default schema, defined in the root of the RAML document with the resource type as key., _(*24)

For example, this could be the RAML definition for the /users resource., _(*25)

#%RAML 0.8
title: HATEOAS Inc. Example API
version: v1
baseUri: http://api.hateoas-example.net/{version}
mediaType: application/vnd.api+json
schemas:
  - users: !include users.schema.json
/users:

Entities

This bundle is pretty entity-centric. The way your entities look and the relationships between them, as mapped in Doctrine 2, are essential to the intelligence this bundle employs in determining what your API should look like., _(*26)

Security

Access control is handled by Symfony's Security Component, so either security voters or ACL must be configured., _(*27)

If you don't want security at all, just configure a single voter accepting anything that implements GoIntegro\Hateoas\JsonApi\ResourceEntityInterface. Not the best advice ever, though., _(*28)

What about pagination? I'm pretty sure isGranted will not be called against every single entity in the collection - right?, _(*29)

Absolutely., _(*30)

In order to address this, we came up with a really simple solution. We mixed the security voter and custom filter interfaces., _(*31)

Have your voter/filter implement GoIntegro\Hateoas\Security\VoterFilterInterface and tag it with both the security.voter and hateoas.repo_helper.filter tags., _(*32)

# src/Example/Bundle/AppBundle/Resources/config/services.yml

  security.access.user_voter:
    class: HateoasInc\Bundle\ExampleBundle\Security\Authorization\Voter\UserVoter
    public: false
    tags:
      - { name: security.voter }
      - { name: hateoas.repo_helper.filter }

Your access control logic for viewing the entity should be expressed in the shape of a security voter within the method vote, and the shape of a fetch request filter within the method filter., _(*33)

Voilà., _(*34)

Validation

Default validation is handled by Symfony's Validator Component, so you can configure basic validation right on your entities., _(*35)

Also, you can extend the validator by writing your own constraints., _(*36)

Since constraints can be services, this means that you are probably not going to need to create custom builders or mutators., _(*37)

Violations of the unique entity constraint ultimately result in a 409 HTTP response status, conflict. :fire:, _(*38)

JSON-API requires 409 to only be used when attempting to create a relationship that already exists. We are expanding its application to include any instance in which validation fails due to a conflict with another resource., _(*39)

If you'd like to create a custom constraint in which a violation is taken to mean conflict between resources, just have it implement GoIntegro\Hateoas\Entity\Validation\ConflictConstraintInterface., _(*40)

Transactions

Creating, updating, or deleting multiple resources on a single request is supported by JSON-API - but no partial updates are allowed., _(*41)

We use explicit transaction demarcation on the controller that handles creating, updating, and deleting resources magically so that this rule is enforced., _(*42)

Creating, updating, and deleting

As mentioned, services for creating, updating, and deleting resources are provided by default., _(*43)

But what about your business logic? That wouldn't fly far., _(*44)

You can register services that handle each of these operations for specific resources called builders, mutators, and deleters by tagging them., _(*45)

# src/Example/Bundle/AppBundle/Resources/config/services.yml

example.your_resource.builder:
    class: Example\Bundle\AppBundle\Entity\YourEntityBuilder
    public: false
    arguments:
      - @doctrine.orm.entity_manager
      - @validator
      - @security.context
    tags:
      -  { name: hateoas.entity.builder, resource_type: your_resource }

This builder class should implement a certain interface. Here are the available tags and interfaces., _(*46)

Updating relationships and association ownership

You've set everything up, made an HTTP request that should relate two resources, got a 200/204 status response, but your relationship wasn't created., _(*47)

What gives? Here's a likely cause., _(*48)

Remember that we will only operate on the entity associated to the resource you're altering. Even when relating resources, you're making a request to either one of them., _(*49)

E.g. POST /users/1/links/user-groups is acting upon /users., _(*50)

If the entity you're acting upon isn't the owner of the association in the eyes of Doctrine, your changes will not be persisted., _(*51)

You need to do two things: - Enable cascading on the inverse side of the association; - Have the setter on the inverse side also alter the entity it got., _(*52)

Here's an example., _(*53)

members->add($member);
        $member->setTeam($this); // This is what you need.

        return $this;
    }
}
?>

This bit of advice would fit a FAQ or troubleshooting section just as well., _(*54)

Translatable content

The framework provides support for working with the translatable entities feature of @l3pp4rd's Doctrine Extensions (AKA Gedmo) through @stof's Bundle., _(*55)

When fetching or updating a translatable resource, the framework will act upon the translation corresponding to the locale negotiated by the GoIntegro\Hateoas\JsonApi\Request\DefaultLocaleNegotiator., _(*56)

You can override the default locale negotiator by having your negotiator class implement GoIntegro\Hateoas\JsonApi\Request\LocaleNegotiatorInterface and exposing it as a service using the tag hateoas.request_parser.locale., _(*57)

You can fetch all translations for one or many resources by passing the query string parameter meta=i18n. You can also update them by making a PUT request with the same body you get., _(*58)

This is an example out of the example app., _(*59)

GET /articles/1?meta=i18n

Accept-Language: en_GB

{
    "links": {
        "articles.owner": {
            "href": "/api/v1/users/{articles.owner}",
            "type": "users"
        }
    },
    "articles": {
        "id": "1",
        "type": "articles",
        "title": "This is my standing on stuff",
        "content": "Here's me, standing on stuff. E.g. a carrot.",
        "links": {
            "owner": "1"
        }
    },
    "meta": {
        "articles": {
            "translations": {
                "content": [
                    {
                        "locale": "fr",
                        "value": "Ici est moi, debout sur des trucs. Par exemple une carotte."
                    },
                    {
                        "locale": "it",
                        "value": "Qui sono io, in piedi su roba. E.g. una carota."
                    }
                ],
                "title": [
                    {
                        "locale": "fr",
                        "value": "Ce est ma position sur la substance"
                    },
                    {
                        "locale": "it",
                        "value": "Questa è la mia posizione su roba"
                    }
                ]
            }
        }
    }
}

Parlez-vous JSON-API? Oui, oui., _(*60)

-, _(*61)

Extending

Muggle Controllers

If you want to override the magic controllers for whatever reason, just create a good old Symfony 2 controller., _(*62)

You can use entities implementing the ResourceEntityInterface with the services provided by the HATEOAS bundle quite independently., _(*63)

Here's a pretty basic example., _(*64)

get('hateoas.resource_manager');
      $resource = $resourceManager->createResourceFactory()
        ->setEntity($user)
        ->create();

      $json = $resourceManager->createSerializerFactory()
        ->setDocumentResources($resource)
        ->create()
        ->serialize();

      return $this->createETagResponse($json);
    }
?>

Check out the bundle's services.yml for a glimpse at the HATEOAS arsenal we keep there., _(*65)

Ghosts :ghost:

I know what you're thinking - what if my resource does not have an entity? Am I left to fend for myself in the cold dark night?, _(*66)

Not a chance. Ghosts are there with you, in the dark. To help you out., _(*67)

Ghosts are what you create ghost-resources from instead of persisted entities. They are created within a custom HATEOAS controller, and can be fed to the resource factory in lieu of an entity. They define their relationships rather than the ORM knowing about them beforehand., _(*68)

What you use for an Id, and the extent to which you use them is entirely up to you., _(*69)

id = $id;
        $this->stars = new ArrayCollection;
    }

    /**
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param Star $star
     * @return self
     */
    public function setBrightestStar(Star $star)
    {
        $this->brightestStar = $star;

        return $this;
    }

    /**
     * @return Star
     */
    public function getBrightestStar()
    {
        return $this->brightestStar;
    }

    /**
     * @return ArrayCollection
     */
    public function getStars()
    {
        return $this->stars;
    }

    /**
     * @param \GoIntegro\Bundle\SomeBundle\Entity\Star $star
     * @return self
     */
    public function addStar(Star $star)
    {
        $this->stars[] = $star;

        return $this;
    }

    /**
     * @return ResourceRelationships
     */
    public static function getRelationships()
    {
        $relationships = new ResourceRelationships;
        $relationships->toMany['stars'] = new ResourceRelationship(
            'GoIntegro\Bundle\SomeBundle\Entity\Star',
            'stars', // resource type
            'stars', // resource sub-type
            'toMany', // relationship kind
            'stars', // relationship name
            'stars' // mapping field
        );
        $relationships->toOne['brightest-star'] = new ResourceRelationship(
            'GoIntegro\Bundle\SomeBundle\Entity\Star',
            'stars',
            'stars',
            'toOne',
            'brightest-star',
            'brightestStar'
        );

        return $relationships;
    }
}
?>

Query filters

The standard fetch request filters are bundled along with the bundle., _(*70)

This is the service providing them., _(*71)

# GoIntegro/HateoasBundle/Resources/config/services.yml

  hateoas.repo_helper.default_filter:
    class: GoIntegro\Hateoas\JsonApi\Request\DefaultFilter
    public: false
    tags:
      - name: hateoas.repo_helper.filter

If you're somewhat familiar with tagged services, you probably guessed that you can add your own., _(*72)

Just have your filter class implement GoIntegro\Hateoas\JsonApi\Request\FilterInterface, and add the hateoas.repo_helper.filter tag when you declare it as a service., _(*73)

Your filter should use the entity and filter parameters it gets in order to decide whether or not to act. Make sure a single class doesn't get too much filtering responsibility., _(*74)

Testing

The bundle comes with a comfy PHPUnit test case designed to make HATEOAS API functional tests., _(*75)

A simple HTTP client makes the request and assertions are made using JSON schemas., _(*76)

     */
    protected static function getFixtures()
    {
        return array(new SomeDataFixture);
    }

    public function testGettingMany200()
    {
        /* Given... (Fixture) */
        $url = $this->getRootUrl() . self::RESOURCE_PATH;
        $client = $this->createHttpClient($url);
        /* When... (Action) */
        $transfer = $client->exec();
        /* Then... (Assertions) */
        $this->assertResponseOK($client);
        $this->assertJsonApiSchema($transfer);
        $schema = __DIR__ . self::RESOURCE_JSON_SCHEMA;
        $this->assertJsonSchema($schema, $transfer);
    }

    public function testGettingSortedBySomeCustomField400()
    {
        /* Given... (Fixture) */
        $url = $this->getRootUrl()
            . self::RESOURCE_PATH
            . '?sort=some-custom-field';
        $client = $this->createHttpClient($url);
        /* When... (Action) */
        $transfer = $client->exec();
        /* Then... (Assertions) */
        $this->assertResponseBadRequest($client);
    }
}
?>

Error handling

JSON-API covers how to inform about errors as well., _(*77)

Our implementation isn't trully as complete as could be, but you can tell Twig to use our ExceptionController instead of its own in order to have your errors serialized properly., _(*78)

# app/config/config.yml

twig:
  exception_controller: 'GoIntegro\Hateoas\Controller\ExceptionController::showAction'

Fetching multiple URLs

Here's something useful but not RESTful., _(*79)

You can use the /multi action to fetch several JSON-API URLs, and this won't even result in an additional HTTP request., _(*80)

/multi?url[]=%2Fapi%2Fv1%2Fusers&url[]=%2Fapi%2Fv1%2Fposts

The URLs just need to be encoded, but you can use the full set of JSON-API functionality supported., _(*81)

A blender service wil make sure to notify you if, by chance, the URLs provided are not mergeable., _(*82)

Caching

Yeah. These processes are not cheap., _(*83)

You might want to hold on to that metadata you've mined or that resource you've serialized for a while., _(*84)

Resource Metadata

The resource metadata describes a resource type. It describes its name, fields, its relationships to other resources, and other such things., _(*85)

It's akin to the Doctrine 2 entity mapping, Doctrine\ORM\Mapping\ClassMetadata., _(*86)

We obtain this class by inspecting an entity's mapping and its class, using the ORM and reflection., _(*87)

You can cache a resource type's metadata for as long as neither of these two things change., _(*88)

Here's how. Add this parameter., _(*89)

# app/config/parameters.yml

parameters:
    hateoas.resource_cache.class: GoIntegro\Hateoas\JsonApi\ArrayResourceCache

You can customize your Redis or Memcached configuration by using any of the following options. Below are the default values., _(*90)

# app/config/config.yml

go_integro_hateoas:
  cache: ~
    # resource:
    #   redis:
    #     parameters:
    #       scheme: tcp
    #       host: 127.0.0.1
    #       port: 6379
    #     options: []
    #   memcached: ~
    #     persistent_id: null
    #     servers:
    #       - host: 127.0.0.1
    #         port: 11211

HTTP Response

Fetch responses are all delivered with an Etag., _(*91)

The Etag is created from the full body of the response, so it accurately represents the JSON-API document you're fetching, along with its includes, sparse fields, meta, etc., _(*92)

Etags on requests are checked using Symfony., _(*93)

Feedback

Feel free to open an issue if you have valuable (or otherwise) feedback. Hoping to hear from you (either way)., _(*94)

If you're going to dare rocking so hard as to make a pull request, use the master branch for fixes, and the develop branch for proposed features., _(*95)

We are using the Git Flow branching model. Here's a nice cheat-sheet that can give you a general idea of how it goes., _(*96)

New code should not exceed the legendary eighty char boundary, and be fully documented., _(*97)

FYI: we still need to migrate the issues from the bundle repo., _(*98)

Roadmap

Any issue labeled enhancement goes., _(*99)

PATCH support is coming soon., _(*100)

(Most of the enhancement issues are still in the bundle repo.), _(*101)

Disclaimer

You might have noticed something fishy in the PHP snippets above., _(*102)

Closing tags., _(*103)

I don't actually support using them, my text editor just goes crazy if I don't., _(*104)