Download the PHP package pccomponentes/documentation-bundle without Composer
On this page you can find all versions of the php package pccomponentes/documentation-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pccomponentes/documentation-bundle
More information about pccomponentes/documentation-bundle
Files in pccomponentes/documentation-bundle
Package documentation-bundle
Short Description PcComponentes Documentation Bundle
License MIT
Informations about the package documentation-bundle
Documentation Bundle
The documentation bundle manages the required routes and templates in order to show documentation both in OpenApi and AsyncApi formats.
Installation
Add the pccomponentes/documentation-bundle package to your require section in the composer.json file.
Add the DocumentationBundle to your application's kernel.
Depending on your installation, maybe you should add it to the bundles.php file instead.
Usage
Configure the paths to your YAML files in your config.yml (Both keys are optional).
Enable the paths in your routing.yml file.
You can choose a prefix where the documentation will be published.
After this, you should be able to see the Swagger interface at /openapi
(or /docs/openapi
if you used the docs
prefix), the AsyncApi at /asyncapi
, and all of your event converters at /converters
.
Also, you can customize the SwaggerUI options
using the key swagger_options
, and the AsyncApi ones
using asyncapi_options
, for example:
In addition, you can add your custom links to the homepage using the links
key, here is an example:
All versions of documentation-bundle with dependencies
ext-json Version *
symfony/http-foundation Version ^4.4 || ^5.0 || ^6.0 || ^7.0
symfony/dependency-injection Version ^4.4 || ^5.0 || ^6.0 || ^7.0
symfony/config Version ^4.4 || ^5.0 || ^6.0 || ^7.0
symfony/http-kernel Version ^4.4 || ^5.0 || ^6.0 || ^7.0
symfony/routing Version ^4.4 || ^5.0 || ^6.0 || ^7.0
symfony/yaml Version ^4.4 || ^5.0 || ^6.0 || ^7.0
pccomponentes/ddd Version ^2.0 || ^3.0 || ^4.0