yoanm/symfony-jsonrpc-http-server-doc

Symfony bundle for easy JSON-RPC server documentation

v1.1.0 2023-04-10 11:25 UTC

Requires

• php: ^8.0
• ext-json: *
• symfony/config: ^4.4 || ^5.4 || ^6.0
• symfony/dependency-injection: ^4.4 || ^5.4 || ^6.0
• symfony/event-dispatcher-contracts: ^1.0 || ^2.0
• symfony/http-foundation: ^4.4 || ^5.4 || ^6.0
• symfony/http-kernel: ^4.4 || ^5.4 || ^6.0
• yoanm/jsonrpc-server-doc-sdk: ^0.3 || ^1.0
• yoanm/jsonrpc-server-sdk: ^3.3
• yoanm/symfony-jsonrpc-http-server: ^3.3

Requires (Dev)

• behat/behat: ^3.9.0
• dvdoug/behat-code-coverage: ^5.0
• matthiasnoback/symfony-config-test: ^4.0
• matthiasnoback/symfony-dependency-injection-test: ^4.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: ^4.4 || ^5.4 || ^6.0
• symfony/routing: ^4.4 || ^5.4 || ^6.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
• yoanm/symfony-jsonrpc-http-server-openapi-doc: Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
• yoanm/symfony-jsonrpc-http-server-swagger-doc: Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation
• yoanm/symfony-jsonrpc-params-sf-constraints-doc: Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation

MIT

• Yoanm

README

Symfony bundle for easy JSON-RPC server documentation

Symfony bundle for yoanm/jsonrpc-server-doc-sdk

See yoanm/symfony-jsonrpc-params-sf-constraints-doc for params documentation generation.

Availble formats

• Raw : Built-in json format at /doc or /doc/raw.json
• Swagger : yoanm/symfony-jsonrpc-http-server-swagger-doc
• OpenApi : yoanm/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 yoanm/symfony-jsonrpc-http-server documentation.

• Query your project at /doc endpoint and you will have a json documentation of your server.

Contributing

See contributing note