adgoal / symfony-jsonrpc-http-server-doc
Symfony bundle for easy JSON-RPC server documentation
Requires
- php: >=7.2
- adgoal/jsonrpc-server-doc-sdk: ^0.3
- symfony/config: ^4.0 || ^5.0
- symfony/dependency-injection: ^4.0 || ^5.0
- symfony/http-kernel: ^4.0 || ^5.0
- yoanm/jsonrpc-server-sdk: ^3.0
- yoanm/symfony-jsonrpc-http-server: ^2.0
Requires (Dev)
- behat/behat: ~3.0
- matthiasnoback/symfony-config-test: ^3.0 || ^4.0
- matthiasnoback/symfony-dependency-injection-test: ^3.0 || ^4.0
- phpunit/phpunit: ^7.0 || ^8.0
- squizlabs/php_codesniffer: 3.*
- symfony/framework-bundle: ^3.0 || ^4.0
- symfony/routing: ^3.0 || ^4.0
- yoanm/php-unit-extended: ~1.0
Suggests
- adgoal/symfony-jsonrpc-http-server-openapi-doc: Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
- adgoal/symfony-jsonrpc-params-sf-constraints-doc: Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation
- yoanm/symfony-jsonrpc-http-server: Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
- yoanm/symfony-jsonrpc-http-server-swagger-doc: Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation
This package is auto-updated.
Last update: 2024-10-29 06:11:43 UTC
README
Symfony bundle for easy JSON-RPC server documentation
Symfony bundle for yoanm/jsonrpc-server-doc-sdk
See adgoal/symfony-jsonrpc-params-sf-constraints-doc for params documentation generation.
Availble formats
- Raw : Built-in
json
format at/doc
or/doc/raw.json
- Swagger : adgoal/symfony-jsonrpc-http-server-swagger-doc
- OpenApi : adgoal/symfony-jsonrpc-http-server-openapi-doc
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
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], ... ];
-
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 documentation.
-
Query your project at
/doc
endpoint and you will have ajson
documentation of your server.