yoanm/symfony-jsonrpc-http-server-openapi-doc

Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation

Symfony JSON-RPC Http server OpenAPI documentation

, _(*1)

, _(*2)

, _(*3)

, _(*4)

Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation, _(*5)

Symfony bundle for yoanm/jsonrpc-http-server-openapi-doc-sdk, _(*6)

Versions

• Symfony v3/4 - PHP >=7.1 : ^v0.X
• Symfony v4/5 - PHP >=7.2 : ^v1.0

How to use

Once configured, your project is ready to handle HTTP GET request on /doc/openapi.json endpoint. Result will be a openapi compatible file., _(*7)

See below how to configure it., _(*8)

Configuration

Behat demo app configuration folders can be used as examples., _(*9)

• Add the bundles in your config/bundles.php file:, _(*10)

  // config/bundles.php
  return [
    ...
    Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
    Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
    Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
    Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\JsonRpcHttpServerOpenAPIDocBundle::class => ['all' => true],
    ...
  ];
  

• Configure yoanm/symfony-jsonrpc-http-server as described on yoanm/symfony-jsonrpc-http-server documentation., _(*11)

• Configure yoanm/symfony-jsonrpc-http-server-doc as described on yoanm/symfony-jsonrpc-http-server-doc documentation., _(*12)

• Query your project at /doc/openapi.json endpoint and you will have a OpenAPI json documentation file of your server., _(*13)

Event

You are able to enhance resulting documentation by listening on json_rpc_http_server_openapi_doc.array_created event., _(*14)

See below an example of listener service configuration:, _(*15)

  method_doc_created.listener:
    class: Full\Namespace\DocCreatedListener # <-- replace by your class name
    tags:
      - name: 'kernel.event_listener'
        event: 'json_rpc_http_server_openapi_doc.array_created'
        method: 'enhanceMethodDoc' # <-- replace by your method name

You will receive an event of type OpenAPIDocCreatedEvent., _(*16)

You can take example on Behat DocCreatedListener  , _(*17)

Contributing

See contributing note, _(*18)