yoanm / symfony-jsonrpc-http-server
Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
Installs: 131 257
Dependents: 3
Suggesters: 15
Security: 0
Stars: 10
Watchers: 3
Forks: 13
Open Issues: 5
Requires
- php: ^8.0
- psr/container: ^1.0
- symfony/config: ^4.4 || ^5.4 || ^6.0
- symfony/dependency-injection: ^4.4 || ^5.4 || ^6.0
- symfony/event-dispatcher: ^4.4 || ^5.4 || ^6.0
- symfony/event-dispatcher-contracts: ^1.0 || ^2.0 || ^3.0
- symfony/http-foundation: ^4.4 || ^5.4 || ^6.0
- symfony/http-kernel: ^4.4 || ^5.4 || ^6.0
- yoanm/jsonrpc-server-sdk: ^3.3
Requires (Dev)
- behat/behat: ^3.9.0
- dvdoug/behat-code-coverage: ^5.0
- matthiasnoback/symfony-config-test: ^4.0
- matthiasnoback/symfony-dependency-injection-test: ^4.0
- phpspec/prophecy: ^1.15
- phpspec/prophecy-phpunit: ^2.0
- phpunit/php-code-coverage: ^9.2.4
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.5
- symfony/framework-bundle: ^4.4 || ^5.4 || ^6.0
- symfony/routing: ^4.4 || ^5.4 || ^6.0
- yoanm/php-unit-extended: ^2.0
Suggests
- yoanm/symfony-jsonrpc-http-server-doc: JSON-RPC documentation Bundle
- yoanm/symfony-jsonrpc-params-validator: Symfony bundle for easy JSON-RPC params validation
README
Symfony JSON-RPC HTTP Server to convert an HTTP json-rpc request into HTTP json-rpc response.
Symfony bundle for yoanm/jsonrpc-server-sdk
See yoanm/symfony-jsonrpc-params-validator for params validation.
See yoanm/symfony-jsonrpc-http-server-doc for documentation generation.
Versions
-
Symfony v3/4 - PHP >=7.1 :
^2.0
⚠️⚠️
v2.1.0
andv2.1.1
were badly taggued, usedv3.0.0
instead ! ⚠️⚠️ -
Symfony v4/5 - PHP >=7.2 :
~3.0.0
-
Symfony v4/5 - PHP >=7.3 :
^3.1
-
Symfony v4.4/5.4 - PHP ^8.0 :
^3.2
-
Symfony v4.4/5.4/6.x - PHP ^8.0 :
^3.3
How to use
Once configured, your project is ready to handle HTTP POST
request on /json-rpc
endpoint.
See below how to configure it.
Configuration
Bundle requires only one thing :
- JSON-RPC Methods which are compatible with
yoanm/jsonrpc-server-sdk
It comes with built-in method resolver which use a service locator. Using a service locator allow to load (and so instanciate dependencies, dependencies of dependencies, etc) method only when required (usually only one method is required by request, except for batch requests which will load one or more methods).
Behat demo app configuration folders can be used as examples.
-
Add the bundles in your
config/bundles.php
file:// config/bundles.php return [ ... Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true], Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true], ... ];
-
Add the following in your routing configuration :
# config/routes.yaml json-rpc-endpoint: resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'
-
Add the following in your configuration :
# config/config.yaml framework: secret: '%env(APP_SECRET)%' json_rpc_http_server: ~ # Or the following in case you want to customize endpoint path #json_rpc_http_server: # endpoint: '/my-custom-endpoint' # Default to '/json-rpc'
JSON-RPC Method mapping
In order to inject yours JSON-RPC method into the server add the tag json_rpc_http_server.jsonrpc_method
and the key/value method
like following example :
services: method-a.service-id: class: Method\A\Class tags: - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a' } - { name: 'json_rpc_http_server.jsonrpc_method', method: 'method-a-alias' }
Methods mapping aware
In case you want to be aware of which methods are registered inside the JSON-RPC server, you can use the json_rpc_http_server.method_aware
. Your class must implements JsonRpcMethodAwareInterface
.
use Yoanm\JsonRpcServer\Domain\JsonRpcMethodAwareInterface; use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface; class MappingCollector implements JsonRpcMethodAwareInterface { /** @var JsonRpcMethodInterface[] */ private $mappingList = []; public function addJsonRpcMethod(string $methodName, JsonRpcMethodInterface $method): void { $this->mappingList[$methodName] = $method; } /** * @return JsonRpcMethodInterface[] */ public function getMappingList() : array { return $this->mappingList; } }
mapping_aware_service: class: App\Collector\MappingCollector tags: ['json_rpc_http_server.method_aware']
Debug mode
You can setup 'debug' mode for the JSON-RPC server, which allows display of verbose error information within the response JSON body. This information contains actual exception class name, code, message and stack trace.
Note: you should never enable 'debug' mode in 'production' environment, since it will expose vital internal information to the API consumer.
Configuration example:
# file 'config/packages/json_rpc.yaml' json_rpc_http_server: endpoint: '/json-rpc' debug: enabled: false max_trace_size: 10 show_trace_arguments: true simplify_trace_arguments: true when@dev: json_rpc_http_server: debug: enabled: true when@test: json_rpc_http_server: debug: enabled: true