druidvav / api-service-bundle

v4.4.2 2026-10-12 16:39 UTC

Requires

• php: >=7.4.0
• ext-json: *
• symfony/contracts: ^1.0 || ^2.5 || ^3.0
• symfony/event-dispatcher: ^5.4 || ^6.0 || ^7.0 || ^8.0
• symfony/framework-bundle: ^5.4 || ^6.0 || ^7.0 || ^8.0
• symfony/http-foundation: ^5.4 || ^6.0 || ^7.0 || ^8.0
• symfony/stopwatch: ^5.4 || ^6.0 || ^7.0 || ^8.0

Requires (Dev)

• phpstan/phpstan: ^2.1
• phpstan/phpstan-doctrine: ^2.0
• rector/rector: ^2.4

MIT

Published on Packagist.org on 2026-10-12 16:39 UTC

README

Installation

Step 1: Download DvApiServiceBundle using composer

Require the druidvav/api-service-bundle with composer Composer.

$ composer require druidvav/api-service-bundle

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php

// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // ...
            new Druidvav\ApiServiceBundle\DvApiServiceBundle(),
        // ...
    );
}

Step 3: Configure the DvApiServiceBundle

# app/config/config.yml

dv_api_service:
    logger: "@monolog.logger.api"

Step 4: Define your api service files

# src/AppBundle/Resources/config/services.yml

services:
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.

    AppBundle\ApiService\:
        resource: '../../ApiService/*'
        tags: [ "jsonrpc.api-service" ]

JSON-RPC request params

JsonRpcRequest accepts JSON-RPC 2.0 requests with an integer or string id, a nonblank method, and a required params object or array. An object supplies named parameters; an array supplies positional parameters. For example:

{"jsonrpc":"2.0","id":0,"method":"item.get","params":{"code":"A1"}}

getParams() continues to return a PHP array, and getParam() returns a value from that array, for compatibility with existing services. Nested JSON objects and arrays are both decoded as PHP arrays.