Yii2 JSON-RPC
Yii2 extension for JSON-RPC server implementation. Works not as Remote Procedure Call, but Remote Action Call, therefor leaves all Yii2 power for your service., (*1)
, (*2)
Features
- Uses full Yii2 power, because method string is translated into a route.
- Lightweight.
- Fully JSON-RPC 2.0 compliant.
Usage
Entry point:, (*3)
<?php
namespace app\controllers;
use \georgique\yii2\jsonrpc\Controller;
class JsonRpcController extends Controller {
// Practically you don't need anything else in this controller,
// unless you want to customize entry point somehow.
}
Entry point with different way to pass params:, (*4)
<?php
namespace app\controllers;
use \georgique\yii2\jsonrpc\Controller;
class JsonRpcBodyController extends Controller {
// With the customization JSON RPC params will be passed to the target action
// as request body params, not as action function arguments
public $paramsPassMethod = self::JSON_RPC_PARAMS_PASS_BODY;
}
Controller with target actions which we are going to call:, (*5)
<?php
namespace app\modules\api1\controllers;
// There are some minor side-effects of this solutions, because original request is made to the
// entry point, not to the target controller and action. Be careful working with Request object,
// especially when working on access restriction to the target actions. For example, you want an
// action to be reached only with GET verb only, but you do POST request to the endpoint. In that
// case you will get Internal Error because access will be denied.
class ExampleController extends \yii\web\Controller {
// Note that URL patterns won't be used to resolve the method - this would not be resourse-wise.
// Method string should simply be [[module.]controller.]action where module and controller parts
// can be omitted, so default module and index controller will be used.
public function actionTry() {
return "You've got it!";
}
// Method params are directly translated into action arguments. Make sure your call matches action
// signature.
public function actionTryWithParams($foo) {
return "Params received: \$foo = $foo.";
}
// Passing params as Yii request body params must be handy too, when we need to do a massive
// attribute assignment for example.
public function actionTryWithBodyParams() {
$output = "Params received: ";
$output_chunks = array();
foreach (\Yii::$app->request->getBodyParams() as $name => $value) {
$output_chunks[] = "$name = $value\n";
}
return $output . implode(', ', $output_chunks) . '.';
}
}
Now this is how calls and responses will look like:, (*6)
-> {"jsonrpc": "2.0", "method": "api1.example.try", "id": 1}
<- {"jsonrpc": "2.0", "result": "You've got it!", "id": 1}
-> {"jsonrpc": "2.0", "method": "api1.example.try-with-params", "params": {"foo": "bar"}, "id": 2}
<- {"jsonrpc": "2.0", "result": "Params received: $foo = bar.", "id": 2}
// Using alternative entry point:
-> {"jsonrpc": "2.0", "method": "api1.example.try-with-body-params", "params": {"foo": "bar", "foo1": "bar1"}, "id": 2}
<- {"jsonrpc": "2.0", "result": "Params received: $foo = bar, $foo1 = bar1.", "id": 2}
-> {"jsonrpc": "2.0", "method": "api1.example.garbage", "id": 3}
<- {"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found."}, "id": 3}
-> [
{"jsonrpc": "2.0", "method": "api1.example.try", "id": 1},
{"jsonrpc": "2.0", "method": "api1.example.try-with-params", "params": {"foo": "bar"}, "id": 2},
{"jsonrpc": "2.0", "method": "api1.example.garbage", "id": 3}
]
<- [
{"jsonrpc": "2.0", "result": "You've got it!", "id": 1},
{"jsonrpc": "2.0", "result": "Params received: $foo = bar.", "id": 2},
{"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found."}, "id": 3}
]
Author: George Shestayev george.shestayev@gmail.com, (*7)