PHPackages                             adgoal/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. adgoal/symfony-jsonrpc-http-server-doc

ActiveLibrary[API Development](/categories/api)

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

Symfony bundle for easy JSON-RPC server documentation

v0.3.1(6y ago)015[3 PRs](https://github.com/Adgoal/symfony-jsonrpc-http-server-doc/pulls)2MITPHPPHP >=7.2

Since May 14Pushed 5y agoCompare

[ Source](https://github.com/Adgoal/symfony-jsonrpc-http-server-doc)[ Packagist](https://packagist.org/packages/adgoal/symfony-jsonrpc-http-server-doc)[ RSS](/packages/adgoal-symfony-jsonrpc-http-server-doc/feed)WikiDiscussions master Synced today

READMEChangelog (2)Dependencies (14)Versions (11)Used By (2)

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

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

[![License](https://camo.githubusercontent.com/edd1d4b0a22a7cab5beee502d21723d132a30366d9d453e3e924baaa823ea554/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://github.com/adgoal/symfony-jsonrpc-http-server-doc) [![Code size](https://camo.githubusercontent.com/a76441fb079632b272b71b8eab65bbc4b0abce10750729f56c0bdbfb55f04cfd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://github.com/adgoal/symfony-jsonrpc-http-server-doc) [![Dependabot Status](https://camo.githubusercontent.com/6623650827e86b1cbb8563d17ea6bb5ad959f48990a86f8834c9d600b85c27f7/68747470733a2f2f6170692e646570656e6461626f742e636f6d2f6261646765732f7374617475733f686f73743d676974687562267265706f3d6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f63)](https://dependabot.com)

[![Scrutinizer Build Status](https://camo.githubusercontent.com/84b8690a9139e9821d33a86fa7fdfcf5a5b2920366dfb8ac5db7303dff16fd1d/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f6275696c642f672f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e7376673f6c6162656c3d5363727574696e697a6572266c6f676f3d7363727574696e697a6572)](https://scrutinizer-ci.com/g/adgoal/symfony-jsonrpc-http-server-doc/build-status/master) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/1969f9fbbafe01bba316ffe669b6cb59a00fee428e3210e8e1a89d8b5bf20ef0/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632f6d61737465722e7376673f6c6f676f3d7363727574696e697a6572)](https://scrutinizer-ci.com/g/adgoal/symfony-jsonrpc-http-server-doc/?branch=master) [![Code Coverage](https://camo.githubusercontent.com/e8791d99d7c97ecb0cf592d2d3a0a60b28990a8ce27e20058723d5696facbf56/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632f6d61737465722e7376673f6c6f676f3d7363727574696e697a6572)](https://scrutinizer-ci.com/g/adgoal/symfony-jsonrpc-http-server-doc/?branch=master)

[![Travis Build Status](https://camo.githubusercontent.com/c2ea733d2e93bcd0700120517c07e13273ed3ec2e4bcd3844fd74d66a9e36408/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f636f6d2f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632f6d61737465722e7376673f6c6162656c3d547261766973266c6f676f3d747261766973)](https://travis-ci.com/adgoal/symfony-jsonrpc-http-server-doc) [![Travis Symfony Versions](https://camo.githubusercontent.com/71254bab032066a404d9dedfd1ceb2150847d1abdd168b01d196fee30dccaf9c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d763325323025324625323076342d3838393242462e7376673f6c6f676f3d747261766973)](https://symfony.com/)

[![Latest Stable Version](https://camo.githubusercontent.com/9b092aa9c2f84b00f0d9b3b6ac48ecc775efcc536571b8bf2daadfa9c5a16e9d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://packagist.org/packages/adgoal/symfony-jsonrpc-http-server-doc) [![Packagist PHP version](https://camo.githubusercontent.com/e7ed28160d27803dfd19bfc23d98276158a2e27022b9570269d8dcc6fb7d8d43/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6164676f616c2f73796d666f6e792d6a736f6e7270632d687474702d7365727665722d646f632e737667)](https://packagist.org/packages/adgoal/symfony-jsonrpc-http-server-doc)

Symfony bundle for easy JSON-RPC server documentation

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

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

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

[](#availble-formats)

- Raw : Built-in `json` format at `/doc` or `/doc/raw.json`
- Swagger : [adgoal/symfony-jsonrpc-http-server-swagger-doc](https://github.com/adgoal/symfony-jsonrpc-http-server-swagger-doc)
- OpenApi : [adgoal/symfony-jsonrpc-http-server-openapi-doc](https://github.com/adgoal/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 [adgoal/symfony-jsonrpc-http-server](https://github.com/adgoal/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

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.7% 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 ~114 days

Recently: every ~85 days

Total

7

Last Release

2235d ago

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

v0.1.0PHP >=7.1

v0.3.1PHP >=7.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/f4d59ea4bdf00e8a2b7ac18da994d769a06136ca1cfdf9e17306e235901cac31?d=identicon)[wir\_wolf](/maintainers/wir_wolf)

---

Top Contributors

[![yoanm](https://avatars.githubusercontent.com/u/4410697?v=4)](https://github.com/yoanm "yoanm (24 commits)")[![wirwolf](https://avatars.githubusercontent.com/u/8457572?v=4)](https://github.com/wirwolf "wirwolf (3 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

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

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

###  Alternatives

[sylius/sylius

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

8.4k5.6M651](/packages/sylius-sylius)[sulu/headless-bundle

Bundle that provides controllers and services for using Sulu as headless content management system

55133.7k2](/packages/sulu-headless-bundle)

PHPackages © 2026

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