timiki/rpc-server-bundle

JSON-RPC server bundle for symfony

Monday, June 4, 2018
by netesin
Repository
2 Watchers
1 Stars
1,169 Installations

PHP
1 Dependents
1 Suggesters
0 Forks
0 Open issues
23 Versions
37 % Grown

The README.md

JSON-RPC Server bundle for symfony

, _(*1)

JSON-RPC is a remote procedure call protocol encoded in JSON. It is a very simple protocol (and very similar to XML-RPC) , defining only a handful of data types and commands. JSON-RPC allows for notifications (data sent to the server that does not require a response) and for multiple calls to be sent to the server which may be answered out of order., _(*2)

Wikipedia | Specification, _(*3)

Install

Symfony >= 6.4 || 7.0, _(*4)

composer require timiki/rpc-server-bundle "^6.4"

Symfony >= 6.0, _(*5)

composer require timiki/rpc-server-bundle "^6.0"

Deprecated versions

Symfony >= 5.0 use version ^5.0, _(*6)

composer require timiki/rpc-server-bundle "^5.0"

Symfony >= 4.3 use version ^4.1, _(*7)

composer require timiki/rpc-server-bundle "^4.1"

Symfony < 4.3 use version ^4.0, _(*8)

composer require timiki/rpc-server-bundle "^4.0"

Configs


rpc_server:

    # Mapping configs

    # Default mapping
    #   mapping: '%kernel.project_dir%/src/Method' 
    #
    # Multi dir mapping
    #   mapping:
    #   - '%kernel.project_dir%/src/Method1'
    #   - '%kernel.project_dir%/src/Method2'  
    # 
    # Multi handler|dir mapping
    #   mapping:
    #    v1:
    #       - '%kernel.project_dir%/src/Method/V1'
    #    v2:
    #       - '%kernel.project_dir%/src/Method/V2'
    #   

    mapping: '%kernel.project_dir%/src/Method'

    # Cache pool name

    cache: null

    # Serializer service, must be instanced of Timiki\Bundle\RpcServerBundle\Serializer\SerializerInterface
    # By default use Timiki\Bundle\RpcServerBundle\Serializer\BaseSerializer

    serializer: null

    parameters:

        # Allow extra params in JSON request
        allow_extra_params: false

Add methods dir to exclude from autowire, _(*9)

    App\:
        resource: '../src/*'
        exclude: '../src/{Method}'

Controller

Default:, _(*10)

You can use you own controller for JSON-RPC request. For example:, _(*11)

<?php

declare(strict_types=1);

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;

class RpcController extends AbstractController
{
    public function indexAction(Request $request)
    {
        return $this->get('rpc.server.http_handler.default')->handleHttpRequest($request);
    }
}

or add default JSON-RPC route (default POST to /rpc) to you routing.yml, _(*12)

rpc:
    path: /rpc
    defaults: { _controller: Timiki\Bundle\RpcServerBundle\Controller\RpcController::handlerAction }
    methods: [POST]

or controller for different handler (version), _(*13)

rpc:
    path: /{version}
    defaults: { _controller: Timiki\Bundle\RpcServerBundle\Controller\RpcController::handlerAction, version: v1 }
    methods: [POST]

If web site and JSON-RPC server located on a different domain remember about [CORS][3]., _(*14)

Method

<?php

declare(strict_types=1);

namespace App\Method;

use Timiki\Bundle\RpcServerBundle\Attribute as RPC;
use Symfony\Component\Validator\Constraints as Assert;

#[RPC\Method("name")]
#[RPC\Roles(["ROLE_NAME"])]
#[RPC\Cache(3600)]
class Method
{
    #[RPC\Param]
    #[Assert\NotBlank]
    protected $param;

    #[RPC\Execute] 
    public function execute()
    {
        $param = $this->param;

        ...

        return $result;
    }
}

Or you can also use __invoke to declare a call method, _(*15)

<?php

declare(strict_types=1);

namespace App\Method;

use Timiki\Bundle\RpcServerBundle\Attribute as RPC;
use Symfony\Component\Validator\Constraints as Assert;

#[RPC\Method("name")]
#[RPC\Roles(["ROLE_NAME"])]
#[RPC\Cache(3600)]
class Method
{
    #[RPC\Param]
    #[Assert\NotBlank]
    protected $param;

    public function __invoke()
    {
        $param = $this->param;

        ...

        return $result;
    }
}

Inject method execute Context, _(*16)

<?php

declare(strict_types=1);

namespace App\Method;

use Timiki\Bundle\RpcServerBundle\Attribute as RPC;
use Timiki\Bundle\RpcServerBundle\Method\Context;
use Symfony\Component\Validator\Constraints as Assert;

#[RPC\Method("name")]
#[RPC\Roles(["ROLE_NAME"])]
#[RPC\Cache(3600)]
class Method
{
    #[RPC\Param]
    #[Assert\NotBlank]
    protected $param;

    public function __invoke(Context $context)
    {
        $param = $this->param;

        ...

        return $result;
    }
}

Attributes

Method, _(*17)

Define class as JSON-RPC method., _(*18)

#[Method("name")]

Roles, _(*19)

Set roles for access to method. If user not granted for access server return error with message "Method not granted" and code "-32001"., _(*20)

#[Roles(["ROLE_NAME", "ROLE_OTHER"])]

Cache, _(*21)

If define cache in configs it set response lifetime., _(*22)

#[Cache(3600)]

Param, _(*23)

Define JSON-RPC params. Use Symfony\Component\Validator\Constraints for validate it., _(*24)

#[Param]
protected $param;

#[Param]
protected $param = null'; // Default value for param

Execute, _(*25)

Define execute function in class., _(*26)

#[Execute]
public function execute()
{
    // Code
}

or use __invoke, _(*27)

public function __invoke()
{
    // Code
}

Serialize

For convert output result from method to json in bundle used serializer, _(*28)

Config for serializer:, _(*29)

rpc:
    serializer: rpc.server.serializer.base # serialize service id

In bundle include next serializers:, _(*30)

rpc.server.serializer.base - (default) use Symfony serialize to convert result to json rpc.server.serializer.role - use user roles as @Group (@see https://symfony.com/doc/current/components/serializer.html) for control access to output array, _(*31)

Create custom serializer, _(*32)

Here is an example of a simple class for serialization., _(*33)


<?php

declare(strict_types=1);

namespace App\Serializer;

use Timiki\Bundle\RpcServerBundle\Serializer\SerializerInterface;

class MySerializer implements SerializerInterface
{
    public function serialize(mixed $data): string 
        // You serialize logic
    }

    public function toArray(mixed $data): array 
        // You serialize logic
    }
}

And then add custom serializer service id to config, _(*34)

rpc:
    serializer: MySerializer # serialize service id

The Versions

04/06 2018

dev-master

9999999-dev

JSON-RPC server bundle for symfony

symfony-bundle rpc-server-bundle