yoanm/jsonrpc-http-server-swagger-doc-sdk

SDK to generate Http JSON-RPC server documentation for Swagger v2.0

v1.0.0 2023-04-02 11:47 UTC

Requires

• php: ^8.0
• yoanm/jsonrpc-server-doc-sdk: ^1.0

Requires (Dev)

• ext-json: *
• behat/behat: ^3.9.0
• dvdoug/behat-code-coverage: ^5.0
• phpspec/prophecy: ^1.15
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.5
• yoanm/php-unit-extended: ^2.0

Suggests

• yoanm/jsonrpc-params-symfony-constraint-doc-sdk: SDK to generate JSON-RPC documentation from symfony constraint
• yoanm/jsonrpc-server-sdk: Server SDK to convert a json-rpc request string into json-rpc response string
• yoanm/symfony-jsonrpc-http-server: Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
• yoanm/symfony-jsonrpc-http-server-doc: Symfony bundle for easy JSON-RPC server documentation
• yoanm/symfony-jsonrpc-http-server-swagger-doc: Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation

MIT

• Yoanm

README

SDK to generate Http JSON-RPC server documentation for Swagger v2.0

See yoanm/symfony-jsonrpc-http-server-swagger-doc for automatic dependency injection.

How to use

Create the normalizer :

use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ErrorDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ExternalSchemaListDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\OperationDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\RequestDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ResponseDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\SchemaTypeNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ShapeNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\TypeDocNormalizer;
use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Resolver\DefinitionRefResolver;
use Yoanm\JsonRpcHttpServerSwaggerDoc\Infra\Normalizer\DocNormalizer;

$shapeNormalizer = new ShapeNormalizer();
$definitionRefResolver = new DefinitionRefResolver();
$typeDocNormalizer = new TypeDocNormalizer(
    new SchemaTypeNormalizer()
);

$normalizer = new DocNormalizer(
    new ExternalSchemaListDocNormalizer(
        $definitionRefResolver,
        $typeDocNormalizer,
        new ErrorDocNormalizer(
            $typeDocNormalizer,
            $shapeNormalizer
        ),
        $shapeNormalizer
    ),
    new OperationDocNormalizer(
        $definitionRefResolver,
        new RequestDocNormalizer(
            $definitionRefResolver,
            $shapeNormalizer
        ),
        new ResponseDocNormalizer(
            $definitionRefResolver,
            $shapeNormalizer
        )
    )
);

Then you can convert ServerDoc or HttpServerDoc by doing :

use Yoanm\JsonRpcServerDoc\Domain\Model\ServerDoc;

$serverDoc = new ServerDoc();
// Configure server doc
...
// Add methods documentation
...
// Then normalize
/** @var array $swaggerDoc */
$swaggerDoc = $normalizer->normalize($serverDoc);

Contributing

See contributing note