JSON-RPC Server for Laravel

Published on by

JSON-RPC Server for Laravel image

JSON RPC Server is a package to build JSON-RPC 2.0 APIs using the Laravel framework. The package is designed to integrate a lightweight remote procedure call protocol that is simple to use:

namespace App\Http\Procedures;
 
use Sajya\Server\Procedure;
 
class TennisProcedure extends Procedure
{
/**
* The name of the procedure that will be
* displayed and taken into account in the search
*/
public static string $name = 'tennis';
 
/**
* Execute the procedure.
*
* @return string
*/
public function ping()
{
return 'pong';
}
}

Given the above procedure class, this package enables you to call it easily using the following route:

use App\Http\Procedures\TennisProcedure;
 
Route::rpc('/v1/endpoint', [TennisProcedure::class])
->name('rpc.endpoint');

Here's an example of calling the endpoint:

curl 'http://127.0.0.1:8000/api/v1/endpoint' \
--data-binary '{"jsonrpc":"2.0","method":"tennis@ping","id":1}'
 
# Result: {"id":"1","result":"pong","jsonrpc":"2.0"}

Using JSON-RPC with this package, you can batch-process work that allows you to optimize your application by combining multiple requests into a single JSON object:

[
{
"jsonrpc": "2.0",
"method": "message@create",
"params": "...",
"id": 1
},
{
"jsonrpc": "2.0",
"method": "message@create",
"params": "...",
"id": 2
}
]

This package can also help ease building a JSON RPC API with the following features:

  • Authentication
  • Data Validation within procedures
  • API documentation generation
  • Parameter binding resolution in procedures, including model binding
  • Feature testing of JSON RPC procedures
  • Gzip compression middleware

You can learn more about this package, get full installation instructions, and view the source code on GitHub. This package also has useful documentation to get started.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Acquaint Softtech

Hire Laravel developers with AI expertise at $20/hr. Get started in 48 hours.

Visit Acquaint Softtech
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $9500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing

The latest

View all →
Route Metadata Support in Laravel 13.17 image

Route Metadata Support in Laravel 13.17

Read article
Ship AI with Laravel: Failover, Queues, and Middleware for AI Agents image

Ship AI with Laravel: Failover, Queues, and Middleware for AI Agents

Read article
Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower image

Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower

Read article
Showcase Your PhpStorm Expertise on LinkedIn image

Showcase Your PhpStorm Expertise on LinkedIn

Read article
Privacy Filter: Detect PII in Text from Laravel image

Privacy Filter: Detect PII in Text from Laravel

Read article
NationForge: A Self-Hosted Admin Panel for Civic Organizations image

NationForge: A Self-Hosted Admin Panel for Civic Organizations

Read article