{"id":21890564,"url":"https://github.com/patrykbaszak/extended-api-doc-bundle","last_synced_at":"2026-04-10T23:04:16.365Z","repository":{"id":188449237,"uuid":"678759489","full_name":"patrykbaszak/extended-api-doc-bundle","owner":"patrykbaszak","description":"An extension for nelmio/api-doc-bundle that improves the sorting of endpoints by tags and provides minor stylistic corrections to the original Nelmio view.","archived":false,"fork":false,"pushed_at":"2024-02-14T22:43:50.000Z","size":119,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2024-09-16T14:41:51.849Z","etag":null,"topics":["nelmioapidocbundle","openapi","query-parameters","swagger"],"latest_commit_sha":null,"homepage":"","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/patrykbaszak.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-08-15T10:03:19.000Z","updated_at":"2024-02-14T22:34:49.000Z","dependencies_parsed_at":"2024-11-26T17:07:04.735Z","dependency_job_id":"03a8157a-935f-48fb-9135-dbea58534e21","html_url":"https://github.com/patrykbaszak/extended-api-doc-bundle","commit_stats":null,"previous_names":["patrykbaszak/extended-api-doc-bundle"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrykbaszak%2Fextended-api-doc-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrykbaszak%2Fextended-api-doc-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrykbaszak%2Fextended-api-doc-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrykbaszak%2Fextended-api-doc-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrykbaszak","download_url":"https://codeload.github.com/patrykbaszak/extended-api-doc-bundle/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244898446,"owners_count":20528341,"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":["nelmioapidocbundle","openapi","query-parameters","swagger"],"created_at":"2024-11-28T12:15:37.013Z","updated_at":"2026-04-10T23:04:16.329Z","avatar_url":"https://github.com/patrykbaszak.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Extended Api Doc Bundle #\n\nAn extension for `nelmio/api-doc-bundle` that improves the sorting of endpoints by tags and provides minor stylistic corrections to the original Nelmio view.\n\n## Installation\n\nRequired bundles:\n\n```bash\ncomposer require symfony/asset\ncomposer require symfony/twig-bundle\ncomposer require nelmio/api-doc-bundle\ncomposer require pbaszak/extended-api-doc-bundle\n```\n\nRouting Registration:\n\n- /api/doc\n- /api/doc.json\n- /api/doc.yaml\n\n```yaml\n# config/routes.yaml\n...\nextended_api_doc:\n    resource: '@ExtendedApiDocBundle/Resources/routes/*'\n```\n\nSetup metainfo:\n\n```yaml\n# config/packages/nelmio_api_doc.yaml\nparameters:\n    app_title: '%env(APP_TITLE)%'\n    app_description: '%env(APP_DESCRIPTION)%'\n    app_version: '%env(APP_VERSION)%'\n    app_commit_sha_short: '%env(APP_COMMIT_SHA_SHORT)%'\n\nnelmio_api_doc:\n    documentation:\n        info:\n            title: '%app_title%'\n            description: '%app_description%'\n            version: '%app_version% (%app_commit_sha_short%)'\n    areas: # to filter documented areas\n        path_patterns:\n            - ^/api(?!/doc(.json|.yaml)?$)\n```\n\n## Usage\n\nJust open `/api/doc` path on Your server and enjoy!\n\n![alt text](docs/image.png)\n\n## Development\n\n### How to start\n\nStart local environment using this command:\n```sh\nbash start.sh\n```\n\n### How to use **Standard Version**\n\nIf You don't have node_modules directory run:\n```sh\nnpm install\n```\n\n`Major`, `Minor`, `Patch` version update:\n```sh\nnpm run version:major\n# or\nnpm run version:minor\n# or\nnpm run version:patch\n```\n\nPush tags:\n```sh\nnpm run version:release\n# or\nnpm run release\n```\n\nCheck `package.json` for understand what commands do.\n\n### How to use **PHPStan**\n\nMain command:\n```bash\ndocker exec php composer code:analyse\n```\nbut, if You need to add errors to ignored:\n```bash\ndocker exec php composer code:analyse:b\n```\n\n### How to use **PHP CS Fixer**\n\n```bash\ndocker exec php composer code:fix\n```\n\n### How to use **XDebug** in **Visual Studio Code**\n\nCreate new file in Your project: `.vscode/launch.json`\n```json\n{\n    \"version\": \"0.2.0\",\n    \"configurations\": [\n        {\n            \"name\": \"Listen for xDebug\",\n            \"type\": \"php\",\n            \"request\": \"launch\",\n            \"port\": 5902,\n            \"hostname\": \"0.0.0.0\",\n            \"pathMappings\": {\n                \"/app/\": \"${workspaceRoot}\"\n            }\n        }\n    ]\n}\n```\n\nUncomment environments in `.env.local`:\n```env\nXDEBUG_MODE=develop,debug\nXDEBUG_CONFIG=\" client_port=5902 idekey=VSCODE client_host=host.docker.internal discover_client_host=0 start_with_request=yes\"\n```\n\nType `Ctrl + Shift + D` and run `Listen for xDebug`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrykbaszak%2Fextended-api-doc-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrykbaszak%2Fextended-api-doc-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrykbaszak%2Fextended-api-doc-bundle/lists"}