PHPackages                             yoanm/symfony-jsonrpc-http-server-doc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. yoanm/symfony-jsonrpc-http-server-doc

ActiveSymfony-bundle[API Development](/categories/api)

yoanm/symfony-jsonrpc-http-server-doc
=====================================

Symfony bundle for easy JSON-RPC server documentation

v2.0.2(8mo ago)062.6k↓25.9%1[1 issues](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/issues)[2 PRs](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/pulls)4MITPHPPHP ^8.0CI failing

Since May 14Pushed 4mo ago1 watchersCompare

[ Source](https://github.com/yoanm/symfony-jsonrpc-http-server-doc)[ Packagist](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)[ RSS](/packages/yoanm-symfony-jsonrpc-http-server-doc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (20)Versions (17)Used By (4)

Symfony JSON-RPC server documentation
=====================================

[](#symfony-json-rpc-server-documentation)

[![License](https://camo.githubusercontent.com/55ae98f98ffa08c9181138288771a6945623405c0f108db80452cc1853ba4c28/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc)[![Code size](https://camo.githubusercontent.com/415ddda694c10c86557bf47a6e95814d5426c71a097dfaeb9ff4f9c9656c4a4e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc)[![Dependabot Status](https://camo.githubusercontent.com/c92bb5e8b8f727a5d8b9ffca89c66a496d397d9f3e918e5b15d2e56b3be5dbc7/68747470733a2f2f666c61742e62616467656e2e6e65742f6769746875622f646570656e6461626f742f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f63)](https://camo.githubusercontent.com/c92bb5e8b8f727a5d8b9ffca89c66a496d397d9f3e918e5b15d2e56b3be5dbc7/68747470733a2f2f666c61742e62616467656e2e6e65742f6769746875622f646570656e6461626f742f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f63)[![Last commit](https://camo.githubusercontent.com/0520b9887661dd269e2a6823defb12bd74ec3423d728daebb8fa500cbbe966a8/68747470733a2f2f62616467656e2e6e65742f6769746875622f6c6173742d636f6d6d69742f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f63)](https://camo.githubusercontent.com/0520b9887661dd269e2a6823defb12bd74ec3423d728daebb8fa500cbbe966a8/68747470733a2f2f62616467656e2e6e65742f6769746875622f6c6173742d636f6d6d69742f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f63)

[![Scrutinizer Build Status](https://camo.githubusercontent.com/5ddb4db4a946454db0e1274f6ed77b98e80d8d68e399d2327340afcdfbef8c11/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f6275696c642f672f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e7376673f6c6162656c3d5363727574696e697a6572266c6f676f3d7363727574696e697a6572)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/build-status/master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/75475ecd0097301186d798fb7309adb42e1639e32038f950cc930aacca3e0754/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632f6d61737465722e7376673f6c6f676f3d7363727574696e697a6572)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/?branch=master)[![Codacy Badge](https://camo.githubusercontent.com/9fb44e29c9d4bd4ecd206541fbd305938a5a0dbcc15fdab5d1db97a7a24ce23a/68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3866333934323461646430343462343361373062646232333865326634386462)](https://www.codacy.com/gh/yoanm/symfony-jsonrpc-http-server-doc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=yoanm/symfony-jsonrpc-http-server-doc&utm_campaign=Badge_Grade)

[![CI](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/symfony-jsonrpc-http-server-doc/actions/workflows/CI.yml)[![codecov](https://camo.githubusercontent.com/9784d18786d40b61bffb08414c7e41d2e2bc254edc49368c69aa372a7ff46d81/68747470733a2f2f636f6465636f762e696f2f67682f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632f6272616e63682f6d61737465722f67726170682f62616467652e7376673f746f6b656e3d4e486477454255464b35)](https://codecov.io/gh/yoanm/symfony-jsonrpc-http-server-doc)[![Symfony Versions](https://camo.githubusercontent.com/a0f96454a73e2467cd8e9274759de603045720eb9f2e4770b01951d648720bc4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d76352e3425323025324625323076362e3425323025324625323076372e782d3838393242462e7376673f6c6f676f3d676974687562)](https://symfony.com/)

[![Latest Stable Version](https://camo.githubusercontent.com/1acf5748dd678570b1fcc7e28d1e96a5b698c8974914cc7729b446d2859e0f2d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)[![Packagist PHP version](https://camo.githubusercontent.com/5700773fbe86242d2f05b1a5f672ee03bd69f17db835cb2f9d1d504d2ab25f4b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f796f616e6d2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)

Symfony bundle for easy JSON-RPC server documentation

Symfony bundle for [`yoanm/jsonrpc-server-doc-sdk`](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)

See [yoanm/symfony-jsonrpc-params-sf-constraints-doc](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) for params documentation generation.

Versions
--------

[](#versions)

- Symfony v4.4/5.4/6.0 - PHP ^8.0 : `^v1.0`
- Symfony v5.4/6.4/7.0 - PHP ^8.0 : `^v2.0`

Availble formats
----------------

[](#availble-formats)

- Raw : Built-in `json` format at `/doc` or `/doc/raw.json`
- Swagger : [yoanm/symfony-jsonrpc-http-server-swagger-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc)
- OpenApi : [yoanm/symfony-jsonrpc-http-server-openapi-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-openapi-doc)

How to use
----------

[](#how-to-use)

Once configured, your project is ready to handle HTTP `GET` request on `/doc/{?filename}` endpoint.

See below how to configure it.

Configuration
-------------

[](#configuration)

*[Behat demo app configuration folders](./features/demo_app/) can be used as examples.*

- Add the bundles in your `config/bundles.php` file:

    ```
    // config/bundles.php
    return [
        ...
        Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
        ...
    ];
    ```
- Add the following in your routing configuration :

    ```
    # config/routes.yaml
    json-rpc-endpoint:
      resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'

    json-rpc-endpoint-doc:
      resource: '@JsonRpcHttpServerDocBundle/Resources/config/routing/endpoint.xml'
    ```
- Add the following in your configuration :

    ```
    # config/config.yaml
    framework:
      secret: '%env(APP_SECRET)%'

    json_rpc_http_server: ~

    json_rpc_http_server_doc: ~
    # Or the following in case you want to customize endpoint path
    #json_rpc_http_server_doc:
    #  endpoint: '/my-custom-doc-endpoint' # Default to '/doc'
    ```
- Register JSON-RPC methods as described on [yoanm/symfony-jsonrpc-http-server](https://github.com/yoanm/symfony-jsonrpc-http-server) documentation.
- Query your project at `/doc` endpoint and you will have a `json` documentation of your server.

Contributing
------------

[](#contributing)

See [contributing note](./CONTRIBUTING.md)

###  Health Score

52

—

FairBetter than 96% of packages

Maintenance70

Regular maintenance activity

Popularity30

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity76

Established project with proven stability

 Bus Factor1

Top contributor holds 93.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~223 days

Recently: every ~3 days

Total

13

Last Release

244d ago

Major Versions

v0.2.1 → v1.0.02020-03-28

v1.1.2 → v2.0.02025-09-03

PHP version history (4 changes)v0.0.1-alphaPHP >=5.5

v0.1.0PHP >=7.1

v1.0.0PHP >=7.2

v1.1.0PHP ^8.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4410697?v=4)[yoanm](/maintainers/yoanm)[@yoanm](https://github.com/yoanm)

---

Top Contributors

[![yoanm](https://avatars.githubusercontent.com/u/4410697?v=4)](https://github.com/yoanm "yoanm (45 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (1 commits)")

---

Tags

documentation-generatorjson-rpcjsonrpc-server-doc-sdkphpsymfony-bundlesymfony-jsonrpc-http-server

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/yoanm-symfony-jsonrpc-http-server-doc/health.svg)

```
[![Health](https://phpackages.com/badges/yoanm-symfony-jsonrpc-http-server-doc/health.svg)](https://phpackages.com/packages/yoanm-symfony-jsonrpc-http-server-doc)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[vich/uploader-bundle

Ease file uploads attached to entities

1.9k25.9M116](/packages/vich-uploader-bundle)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[shopware/storefront

Storefront for Shopware

684.2M148](/packages/shopware-storefront)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)