{"id":18666187,"url":"https://github.com/pccomponentes/documentation-bundle","last_synced_at":"2026-05-09T10:07:49.335Z","repository":{"id":40478626,"uuid":"485907490","full_name":"PcComponentes/documentation-bundle","owner":"PcComponentes","description":"The documentation bundle manages the required routes and templates in order to show documentation both in OpenApi and AsyncApi formats.","archived":false,"fork":false,"pushed_at":"2023-12-20T11:15:33.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-12-27T17:43:38.331Z","etag":null,"topics":["asyncapi","openapi","symfony-bundle"],"latest_commit_sha":null,"homepage":"https://www.pccomponentes.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PcComponentes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-26T18:41:27.000Z","updated_at":"2022-04-28T07:21:17.000Z","dependencies_parsed_at":"2023-11-29T17:30:50.603Z","dependency_job_id":"17e95cc1-6a93-4b90-8983-222f781b0d4e","html_url":"https://github.com/PcComponentes/documentation-bundle","commit_stats":{"total_commits":6,"total_committers":2,"mean_commits":3.0,"dds":"0.33333333333333337","last_synced_commit":"83d9d062a77148e54ba7a95ec58ff653b7f3e1af"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PcComponentes%2Fdocumentation-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PcComponentes%2Fdocumentation-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PcComponentes%2Fdocumentation-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PcComponentes%2Fdocumentation-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PcComponentes","download_url":"https://codeload.github.com/PcComponentes/documentation-bundle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239493677,"owners_count":19647995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncapi","openapi","symfony-bundle"],"created_at":"2024-11-07T08:30:57.100Z","updated_at":"2025-11-06T12:30:42.449Z","avatar_url":"https://github.com/PcComponentes.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Documentation Bundle\n====================\n\nThe documentation bundle manages the required routes and templates in order to show\ndocumentation both in OpenApi and AsyncApi formats.\n\nInstallation\n------------\n\nAdd the pccomponentes/documentation-bundle package to your require section in the composer.json file.\n\n```bash\n$ composer require pccomponentes/documentation-bundle\n```\n\nAdd the DocumentationBundle to your application's kernel.\n\n```php\n\u003c?php\npublic function registerBundles()\n{\n    $bundles = [\n        // ...\n        new PcComponentes\\DocumentationBundle\\DocumentationBundle(),\n        // ...\n    ];\n    ...\n}\n```\n\nDepending on your installation, maybe you should add it to the bundles.php file instead.\n\n```php\n\u003c?php\n\nreturn [\n    // ...\n    PcComponentes\\DocumentationBundle\\DocumentationBundle::class =\u003e ['all' =\u003e true],\n    // ...\n];\n```\n\nUsage\n-----\n\nConfigure the paths to your YAML files in your config.yml (Both keys are optional).\n\n```yaml\ndocumentation:\n    openapi: 'docs/openapi.yml'\n    asyncapi: 'docs/asyncapi.yml'\n```\n\nEnable the paths in your routing.yml file.\n\n```yaml\ndocumentation:\n    resource: '@DocumentationBundle/Resources/config/routing.yaml'\n    prefix: /docs\n```\n\nYou can choose a prefix where the documentation will be published.\n\nAfter this, you should be able to see the Swagger interface at `/openapi` (or `/docs/openapi` if you used the `docs` \nprefix), the AsyncApi at `/asyncapi`, and all of your event converters at `/converters`.\n\nAlso, you can customize the [SwaggerUI options](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) \nusing the key `swagger_options`, and the [AsyncApi ones](https://github.com/asyncapi/asyncapi-react#web-component)\nusing `asyncapi_options`, for example:\n\n```yaml\ndocumentation:\n    openapi: 'docs/openapi.yml'\n    asyncapi: 'docs/asyncapi.yml'\n    swagger_options:\n        deepLinking: true\n        displayOperationId: true\n        displayRequestDuration: true\n    asyncapi_options:\n        schemaFetchOptions: '{\"method\":\"GET\",\"mode\":\"cors\"}'\n    \n```\n\nIn addition, you can add your custom links to the homepage using the `links` key, here is an example:\n\n```yaml\ndocumentation:\n    links:\n        - title: 'Google'\n          description: 'You can add some notes for each link'\n          url: 'https://www.google.com/'\n        - title: 'Contact PcComponentes'\n          url: 'https://www.pccomponentes.com/soporte/contactar-con-pccomponentes'\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpccomponentes%2Fdocumentation-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpccomponentes%2Fdocumentation-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpccomponentes%2Fdocumentation-bundle/lists"}