README

[] (https://github.com/tourze/php-monorepo/actions) [] (https://codecov.io/gh/tourze/php-monorepo)

English | 中文

A Symfony bundle that provides HTTP endpoints for JSON-RPC services. This bundle creates HTTP controllers that expose JSON-RPC endpoints with support for POST, GET, and OPTIONS methods, as well as JSONP callbacks.

Installation

composer require tourze/json-rpc-http-endpoint-bundle

Quick Start

1. Add the bundle to your config/bundles.php:

<?php
return [
    // ... other bundles
    Tourze\JsonRPCHttpEndpointBundle\JsonRPCHttpEndpointBundle::class => ['all' => true],
];

1. The bundle automatically registers HTTP endpoints for JSON-RPC:
   • POST /json-rpc - Main JSON-RPC endpoint
   • GET /json-rpc - GET method with __payload parameter
   • OPTIONS /json-rpc - CORS preflight support

Features

• Multiple HTTP Methods: Supports POST, GET, and OPTIONS requests
• JSONP Support: GET requests support JSONP callbacks
• CORS Support: Built-in CORS headers for cross-origin requests
• Legacy Routes: Backward compatibility with existing API endpoints
• Automatic Service Discovery: Uses attribute-based controller loading

Usage

POST Requests

Send JSON-RPC requests via POST:

curl -X POST http://your-app.com/json-rpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "method": "your.method", "params": {"param1": "value1"}, "id": 1}'

GET Requests

Send JSON-RPC requests via GET with __payload parameter:

curl "http://your-app.com/json-rpc?__payload=%7B%22jsonrpc%22%3A%222.0%22%2C%22method%22%3A%22your.method%22%2C%22params%22%3A%7B%22param1%22%3A%22value1%22%7D%2C%22id%22%3A1%7D"

JSONP Support

For JSONP requests, add a callback parameter:

curl "http://your-app.com/json-rpc?callback=myCallback&__payload=%7B...%7D"

Configuration

The bundle works with the JSON-RPC endpoint system and requires the following dependencies:

• tourze/json-rpc-endpoint-bundle - Core JSON-RPC endpoint functionality
• tourze/json-rpc-core - JSON-RPC protocol implementation

Available Routes

License

This package is licensed under the MIT License. See the LICENSE file for details.