Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bankiru/rpc-server-bundle
Abstract RPC server
https://github.com/bankiru/rpc-server-bundle
api api-server bundle rpc symfony
Last synced: about 1 month ago
JSON representation
Abstract RPC server
- Host: GitHub
- URL: https://github.com/bankiru/rpc-server-bundle
- Owner: bankiru
- Created: 2016-04-18T09:26:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-08T05:06:32.000Z (about 2 years ago)
- Last Synced: 2024-11-12T21:09:57.708Z (about 1 month ago)
- Topics: api, api-server, bundle, rpc, symfony
- Language: PHP
- Size: 103 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/bankiru/rpc-server-bundle)
[](https://packagist.org/packages/bankiru/rpc-server-bundle)
[](https://packagist.org/packages/bankiru/rpc-server-bundle)
[](https://packagist.org/packages/bankiru/rpc-server-bundle)
[](https://travis-ci.org/bankiru/rpc-server-bundle)
[](https://scrutinizer-ci.com/g/bankiru/rpc-server-bundle/)
[](https://scrutinizer-ci.com/g/bankiru/rpc-server-bundle/)
[](https://insight.sensiolabs.com/projects/53b98f25-6b08-43b2-9ebe-e2d83e17b868)
# HTTP RPC Server bundle
This bundle provides default controller realisation to handle RPC
requests which come to the application via HTTP requests
## Implementations
RPC server does not declares any implementation requirements. Some could be
* JSON-RPC
* SOAP (extends XML-RPC)
or other custom RPC which operates with method+parameters and utilizes single
endpoint for several methods
## HTTP Endpoints
Endpoint is a HTTP route which process basic HTTP request, providing initial parsing
and processing request data
To enable HTTP endpoint you should enable custom endpoint router loader via the following router configuration:
```yaml
# app/config/routing.yml
rpc:
resource: .
type: endpoint
```
Resource value is not important, it is ignored when loading routes as the endpoints are
configured vua config
### Configuration
Basic endpoint configuration looks like
```yaml
rpc:
router:
endpoints:
my-public-endpoint:
path: /
defaults:
_controller: JsonRpcBundle:JsonRpc:jsonRpc
_format: json
context: Default
resources:
- "@MyBundle/Resources/config/service_rpc.yml"
```
This creates endpoint on URL / with generic symfony controller. Also it
pre-populates the methods from the `service_rpc.yml` config file
`my-public-endpoint` will become a route name, so make sure it does not
overlap with other routes until you want it do to this.
### Method routing
Each RPC request has method and parameters. You can configure the application
to handle different methods within different endpoints with different actions
Generic configuration looks like
```yaml
my_bundle:
resource: "@MyBundle/Rpc/"
prefix: my_bundle/
type: annotation
```
Different resource types are supported. Built-in are
#### Annotation
```php
@Method("my-bundle/my-method", context={"private"}, defaultContext=false)
```
#### Yaml
Different endpoint implementation may utilize different controller name parsers, so
`MyBundle:Test:entity` notation is endpoint-dependent. I.e JSON-RPC may search `TestController`
controller in `MyBundle\JsonRpc\TestController`
```yaml
my-bundle/my-method:
controller: "MyBundle:Test:entity"
default_context: true
context: private
```
#### Resource
You can pass directory, class, file, yaml config as method source with
prefix and context inheritance
The following chaing will result in `prefix/annotation/sub` method
handled by `AnnotationController::subAction` with `private`+`default` context
```yaml
private:
resource: jsonrpc_private_nested.yml
context: private
```
```yaml
annotation:
resource: "@JsonRpcTestBundle/JsonRpc"
prefix: prefix/
```
```php
/**
* Class AnnotationController
*
* @package Bankiru\Api\JsonRpc\Test\JsonRpc
* @Method("annotation/")
*/
class AnnotationController extends Controller
{
/**
* @return array
* @Method("sub")
*/
public function subAction()
{
return [];
}
}
```
## Events
This bundle repeats the generic symfony request processing flow. You can
hook your extension into given system events
* `rpc.request` is triggered on handling RPC call
* Routing happens here
* `rpc.controller` is triggered to filter controller (i.e. allows security filtering)
* `rpc.response` is triggered whenever response is acquired by the endpoint processor
* `rpc.view` is triggered if response, returned from controller is not
instance of `RpcResponseInterface`
* `rpc.exception` is triggered when exception is raised during RPC call processing
* `rpc.finish_request` is used to finalize RPC response before it is returned to HTTP controller
## RPC Controller implementation
The goal of implementing controller is to extend abstract `RpcController` passing
`RequestInterface` and endpoint name into `getResponse` method.
`RequestInterface` is an extension of `RpcRequestInterface` with extra attributes
allowing request metadata carrying alongside the request.
The generic solution is to convert incoming symfony `Request` instance into your own
implementation of `RequestInterface` (i.e extract method and args from XML-RPC or JSON-RPC requests)
and send serialized response back, transforming `RpcResponseInterface` back to your response object.
You can also automatically convert `RpcResponseInterface` into your serialized response via
generic symfony view event processing