PHP JSON-RPC 2.0 Server/Client Implementation with Automatic Client Class Generation via SMD

Sergey Bykov

Last update: Feb 14, 2022

Related tags

Overview

eazy-jsonrpc

PHP JSON-RPC 2.0 Server/Client Implementation with Automatic Client Class Generation via SMD

Server

SMD Schema available via /server.php?smd

Public Namespace

Inherits your exposed class from BaseJsonRpcServer or create new BaseJsonRpcServer( $instance );
$server->Execute();

Multiple Namespaces

Create new BaseJsonRpcServer();
Call $server->RegisterInstance( $instance, $namespace ) as many times as you need
$server->Execute();

Client

Generate Client from SMD Schema from generator/ php JsonRpcClientGenerator.php
Use it:

$client = 
   
    ::GetInstance(
    
     );

try {  
  $result = $client->Method(); 
} catch (BaseJsonRpcException $e) {
  // work with exception
}

Client with typed returns by rpcgen

Generate Client from SMD Schema with rpcgen and save it to RpcClient.php
Use it:

$client = RpcClient::GetInstance(
   
    );

try {  
  $result = $client->Method(); 
} catch (BaseJsonRpcException $e) {
  // work with exception
}

Doc

cd generator
php SmdToSwaggerConverter.php 'http://eazyjsonrpc/tests/example-server.php?smd' eazyjsonrpc ../doc/swagger.json
open http://eazyjsonrpc/doc/

Comments

Ability to update Client Options on the Guzzle Client

I am connecting to a JSON-RPC service and used the generator to create my Client. This API requires a header for Authorization, but I don't believe I am able to edit the property $ClientOptions or the $client directly on the BaseJsonRpcClient. Both properties are private, so I can not adjust the generated client to pass the additional headers that are needed. Should $ClientOptions be a protected variable instead of private? Perhaps even make the Guzzle Client a protected variable, so settings can be adjusted as needed? Or another way would be to pass an optional parameter to the BaseJsonRpcClient constructor to use as the ClientOptions for the Guzzle Client. My apologizes if I missed an obvious answer to this problem. But I can't see a way to pass custom headers to the Guzzle Client.

opened by jswinborne 1
License

Is this project Open Source? If you don't add a license, it's not Open Source even if the code is public. By default, everything is copyrighted (all right reserved) even if not explicitly written. That's why there are licenses that circumvent that.

opened by jcubic 1
A lot of updates
Migrate to guzzle http client

Update json rpc client - now it returns result and throw rpc/http errors via exceptions.

Update generator to use new json rpc client
opened by sas1024 0
Bug fix content-type header

В некоторых библиотеках требуется корректный Content-type. Из-за этого глюка около часа мучался с настройками сервера. Оказалось, что проблема в коде.

opened by agentsib 0
array_key_exists(): Argument #2 ($array) must be of type array, stdClass given
Hi! After upgrading PHP to version 8 I've started getting an error:

Fatal error: Uncaught TypeError: array_key_exists(): Argument #2 ($array) must be of type array, stdClass given in /app/vendor/sergeyfast/eazy-jsonrpc/src/EazyJsonRpc/BaseJsonRpcServer.php on line 244

https://github.com/sergeyfast/eazy-jsonrpc/blob/ba6072bbcdb98b5f6c6c84cbea3528faafabe027/src/EazyJsonRpc/BaseJsonRpcServer.php#L244

I was able to make it work just replacing array_key_exists call to the following one:

!property_exists( $params, $param->getName() )

Thank you 🙌
opened by 31337Ghost 0

Releases(v3.0.2)

v3.0.2(May 17, 2021)

Source code(tar.gz)
Source code(zip)

v3.0.1(Apr 6, 2021)

Source code(tar.gz)
Source code(zip)

v3.0.0(Apr 6, 2021)

Source code(tar.gz)
Source code(zip)

v2.0.0(Apr 5, 2021)

Source code(tar.gz)
Source code(zip)