yoanm / symfony-jsonrpc-params-sf-constraints-doc
Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation
Installs: 32 671
Dependents: 0
Suggesters: 3
Security: 0
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 1
Requires
- php: ^8.0
- symfony/config: ^5.4 || ^6.4 || ^7.0
- symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
- symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
- yoanm/jsonrpc-params-symfony-constraint-doc-sdk: ^1.0
- yoanm/jsonrpc-params-symfony-validator-sdk: ^2.0
- yoanm/jsonrpc-server-doc-sdk: ^0.3 || ^1.0
- yoanm/jsonrpc-server-sdk: ^3.0
- yoanm/symfony-jsonrpc-http-server-doc: ^1.1 || ^2.0
Requires (Dev)
- ext-json: *
- behat/behat: ^3.9.0,<=3.16.1
- dvdoug/behat-code-coverage: ^5.0
- matthiasnoback/symfony-config-test: ^4.0 || ^5.0
- matthiasnoback/symfony-dependency-injection-test: ^4.0 || ^5.0
- phpspec/prophecy: ^1.15
- phpspec/prophecy-phpunit: ^2.0
- phpunit/php-code-coverage: ^9.2.4
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.5
- symfony/framework-bundle: ^5.4 || ^6.4 || ^7.0
- symfony/routing: ^5.4 || ^6.4 || ^7.0
- yoanm/php-unit-extended: ^2.0.2
Suggests
- yoanm/symfony-jsonrpc-http-server: Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
This package is auto-updated.
Last update: 2025-09-03 17:52:00 UTC
README
Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation
Symfony bundle for yoanm/jsonrpc-params-symfony-constraint-doc-sdk
Versions
- Symfony v3/4 - PHP >=7.1 :
^v0.X - Symfony v4/5 - PHP >=7.2 :
^v1.0 - Symfony v4.4/5.4/6.x - PHP ^8.0 :
^v1.1 - Symfony v5.4/6.4/7.x - PHP ^8.0 :
^v2.0
How to use
Once configured, your project will automatically create documentation for JSON-RPC params
See below how to configure it.
Configuration
Behat demo app configuration folders 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], Yoanm\SymfonyJsonRpcParamsSfConstraintsDoc\JsonRpcParamsSfConstraintsDocBundle::class => ['all' => true], ... ];
-
Configure
yoanm/symfony-jsonrpc-http-serveras described on yoanm/symfony-jsonrpc-http-server documentation. -
Configure
yoanm/symfony-jsonrpc-http-server-docas described on yoanm/symfony-jsonrpc-http-server-doc documentation. -
Query your project at documentation endpoint and you should see JSON-RPC params documentation for each methods