innmind/rest-server-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Symfony integration of innmind/rest-server

3.0.0 2017-09-30 12:02 UTC

Requires

• php: ~7.1
• innmind/http: ~3.0
• innmind/immutable: ~2.1
• innmind/rest-server: ~5.0
• symfony/dependency-injection: ~3.0
• symfony/framework-bundle: ~3.0
• symfony/http-kernel: ~3.0
• symfony/routing: ~3.0

Requires (Dev)

• phpunit/phpunit: ~6.0
• symfony/console: ^3.3
• symfony/property-access: ^3.3

MIT

• Baptiste Langlade

• rest
• api

README

master	develop

Installation

Via composer:

composer require innmind/rest-server-bundle

Enable the bundle by adding the following line in your app/AppKernel.php of your project:

// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Innmind\Rest\InnmindRestServerBundle,
        );
        // ...
    }
    // ...
}

Then you need to specify the types you allow in the app, here's an example:

innmind_rest_server:
    accept:
        json:
            priority: 10
            media_types:
                application/json: 0
        html:
            priority: 0
            media_types:
                text/html: 10
                application/xhtml+xml: 0
    content_type:
        json:
            priority: 0
            media_types:
                application/json: 0

Here you define you can expose your resources either in json or html. If the client accept any kind of content, it will automatically expose data as json as it has the highest priority. The client can use either text/html or application/xhtml+xml as media type in his Accept header in order for us to expose data as html.

We also describe the fact resources sent to our API must me in json only, and that the Content-Type header sent by the client must be application/json otherwise he will get an error.

In order to work properly, any media type here must have a corresponding serializer encoder (the supportsEnconding must check the request_{media_type} format, example).

Then you need to activate the router by adding this configuration:

# app/config/routing.yml
rest:
    type: innmind_rest
    resource: .

The last part of the configuration is to create a file named rest.yml in your bundle under the folder Resources/config that will contain the definition of your resources. Here's an extended example:

blog:
    resources:
        blog:
            identity: uuid
            gateway: command
            properties:
                uuid:
                    type: string
                title:
                    type: string
                    access: [READ, CREATE, UPDATE]
                content:
                    type: string
                    access: [READ, CREATE, UPDATE]
                tags:
                    type: set
                    options:
                        inner: string
                author:
                    type: string # identifier of the author
    children:
        meta:
            resources:
                author:
                    identity: uuid
                    gateway: command
                    properties:
                        uuid:
                            type: string
                        name:
                            type: string

Now that all the configuration is done, you need to create a service implementing the interface GatewayInterface and tag the service definition with innmind_rest_server.gateway along with an alias to your choosing; the alias is the one you'll use in the configuration of your resources as chown above (which in our case is command).

Such a service definition should look like this:

services:
    my_gateway:
        class: AppBundle\Gateway\MyGateway
        tags:
            - { name: innmind_rest_server.gateway, alias: command }