https://github.com/bankiru/jsonrpc-server-bundle

JSON-RPC server symfony bundle
https://github.com/bankiru/jsonrpc-server-bundle

api api-server bundle json-rpc json-rpc-api json-rpc2 rpc server symfony

Last synced: 2 months ago
JSON representation

JSON-RPC server symfony bundle

• Host: GitHub
• URL: https://github.com/bankiru/jsonrpc-server-bundle
• Owner: bankiru
• Created: 2016-04-18T09:27:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-08T05:04:25.000Z (about 2 years ago)
• Last Synced: 2024-10-01T15:27:04.277Z (3 months ago)
• Topics: api, api-server, bundle, json-rpc, json-rpc-api, json-rpc2, rpc, server, symfony
• Language: PHP
• Size: 82 KB
• Stars: 1
• Watchers: 4
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Latest Stable Version](https://poser.pugx.org/bankiru/jsonrpc-server-bundle/v/stable)](https://packagist.org/packages/bankiru/jsonrpc-server-bundle) 

[![Total Downloads](https://poser.pugx.org/bankiru/jsonrpc-server-bundle/downloads)](https://packagist.org/packages/bankiru/jsonrpc-server-bundle) 

[![Latest Unstable Version](https://poser.pugx.org/bankiru/jsonrpc-server-bundle/v/unstable)](https://packagist.org/packages/bankiru/jsonrpc-server-bundle) 

[![License](https://poser.pugx.org/bankiru/jsonrpc-server-bundle/license)](https://packagist.org/packages/bankiru/jsonrpc-server-bundle)

[![Build Status](https://travis-ci.org/bankiru/jsonrpc-server-bundle.svg)](https://travis-ci.org/bankiru/jsonrpc-server-bundle)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bankiru/jsonrpc-server-bundle/badges/quality-score.png)](https://scrutinizer-ci.com/g/bankiru/jsonrpc-server-bundle/)

[![Code Coverage](https://scrutinizer-ci.com/g/bankiru/jsonrpc-server-bundle/badges/coverage.png)](https://scrutinizer-ci.com/g/bankiru/jsonrpc-server-bundle/)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/8b87b0a7-c8f9-4d7b-9b91-1e4e762a686f/mini.png)](https://insight.sensiolabs.com/projects/8b87b0a7-c8f9-4d7b-9b91-1e4e762a686f)

# JSON-RPC Server bundle

This bundle provides JSON-RPC 2.0 server ontop of the `bankiru/rpc-server-bundle` library.

## Serialization

This bundle uses `rpc.view` event in order to serialize response if request

was instance of `JsonRpcRequestInterface` and the response is not a 

`JsonRpcResponseInterface` object. You can bypass the serialization process 

with sending pre-created response object or implementing your own view listener

### Context

This library utilizes [JMS Serializer Bundle](https://github.com/schmittjoh/JMSSerializerBundle) 

to automatically serialize non-JSON-RPC controller response to serialized view. 

You can specify the serialization context at the routing level. Also you 

could disable default context usage with `with_default_context: false`

## Exception handling

Any unhandled exception from the controller would be automatically 

converted to the proper JSON-RPC failure response with INTERNAL_ERROR (-32603) code.

If you want do display other error you could extend `JsonRpcException` class or 

configure it manually like following:

```php

$exception = new JsonRpcException();

$execption->setJsonRpcError(

    new JsonRpcError(

        JsonRpcError::METHOD_NOT_FOUND,

        'Invalid method',

        (object)['debug_data' => 'some debug data']

    )

);

```

## Specification

Refer to official JSON-RPC 2.0 specification at  http://www.jsonrpc.org/specification