Simple JSON-RPC 2.0 server for Laravel, without batch request.
You can install the package via composer:
composer require bpartner/jsonrpc
php artisan vendor:publish --tag=configin config/jsonrpc.php set namespace and Bearer token (default 1234567890)
If Bearer token not work, add to your .htaccess file this rule
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]
php artisan make:rpc MyHandler After creating handler, in handle method put your business logic and return array with response data.
public function handle(): array
{
$myData = MyBusinessLogicClass::make($this->params);
return ['data' => $myData];
}Send POST request to /jsonrpc/v1/endpoint in Json RPC 2.0 standard with Bearer Token.
{
"jsonrpc": "2.0",
"method": "myHandler",
"params": {
"param1": "param1",
"param2": {
"param3": 123,
}
},
"id": "abracadabra"
}for validate input parameters use rule method in handler.
protected function rule(): array
{
return [
'param1' => 'require|string',
'param2.param3' => 'require|numeric'
];
}You can use any route, middleware and guards for your rpc endpoint.
- Disable default route in
config/jsonrpc.php - Create your custom route
- Create your middleware
- Create your controller and use RpcService
Middleware example
class AuthToken
{
public function handle(Request $request, Closure $next)
{
if ($request->header('x-auth-token') !== config('jsonrpc.token')) {
return response()->json([
'status' => 'error',
'code' => 401,
'message' => 'Unauthorized',
]);
}
return $next($request);
}
}Controller example
namespace App\Http\Controllers
use Bpartner\Jsonrpc\RpcFormRequest;
use Bpartner\Jsonrpc\RpcRequest;
use Bpartner\Jsonrpc\RpcServiceInterface;
use Illuminate\Routing\Controller;
class MyContoller extends Controller
{
public function __invoke(RpcFormRequest $request, RpcServiceInterface $rpcService)
{
return $rpcService->run();
}
}Create own middleware for any RpcHandler
protected string|array $middlewares = 'guest';
//or
protected string|array $middlewares = [
MyMiddleware::class,
SecondMiddleware::class
];This package not support Batch request. For example, this request not supported:
[
{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"},
{"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
{"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"},
{"foo": "boo"},
{"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"},
{"jsonrpc": "2.0", "method": "get_data", "id": "9"}
]The MIT License (MIT). Please see License File for more information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent