Download the PHP package adgoal/symfony-jsonrpc-http-server-openapi-doc without Composer
On this page you can find all versions of the php package adgoal/symfony-jsonrpc-http-server-openapi-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download adgoal/symfony-jsonrpc-http-server-openapi-doc
More information about adgoal/symfony-jsonrpc-http-server-openapi-doc
Files in adgoal/symfony-jsonrpc-http-server-openapi-doc
Package symfony-jsonrpc-http-server-openapi-doc
Short Description Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
License MIT
Informations about the package symfony-jsonrpc-http-server-openapi-doc
Symfony JSON-RPC Http server OpenAPI documentation
Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
Symfony bundle for adgoal/jsonrpc-http-server-openapi-doc-sdk
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.
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:
-
Configure
adgoal/symfony-jsonrpc-http-server
as described on adgoal/symfony-jsonrpc-http-server documentation. -
Configure
adgoal/symfony-jsonrpc-http-server-doc
as described on adgoal/symfony-jsonrpc-http-server-doc documentation. - Query your project at
/doc/openapi.json
endpoint and you will have a OpenAPI json documentation file of your server.
Event
You are able to enhance resulting documentation by listening on json_rpc_http_server_openapi_doc.array_created
event.
See below an example of listener service configuration:
You will receive an event of type OpenAPIDocCreatedEvent
.
You can take example on Behat DocCreatedListener
Contributing
See contributing note
All versions of symfony-jsonrpc-http-server-openapi-doc with dependencies
yoanm/jsonrpc-server-doc-sdk Version ^0.2
adgoal/jsonrpc-http-server-openapi-doc-sdk Version ^0.3
adgoal/symfony-jsonrpc-http-server-doc Version ^0.3
symfony/http-kernel Version ^4.0 || ^5.0
symfony/dependency-injection Version ^4.0 || ^5.0