yoanm/symfony-jsonrpc-params-sf-constraints-doc

Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation

v1.0.1 2020-07-09 11:44 UTC

This package is auto-updated.

Last update: 2022-05-09 16:14:03 UTC


README

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Code Coverage

Travis Build Status Travis Symfony Versions

Latest Stable Version Packagist PHP version

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

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-server as described on yoanm/symfony-jsonrpc-http-server documentation.

  • Configure yoanm/symfony-jsonrpc-http-server-doc as 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

 

Contributing

See contributing note