{"id":20768067,"url":"https://github.com/basster/silex-simple-swagger-provider","last_synced_at":"2025-04-30T11:25:28.241Z","repository":{"id":62492173,"uuid":"56710745","full_name":"Basster/silex-simple-swagger-provider","owner":"Basster","description":"A silex service provider that integrates swagger-php into silex","archived":false,"fork":false,"pushed_at":"2017-04-01T13:33:02.000Z","size":60,"stargazers_count":6,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"silex-2","last_synced_at":"2025-04-14T14:49:19.511Z","etag":null,"topics":[],"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/Basster.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}},"created_at":"2016-04-20T18:27:58.000Z","updated_at":"2018-02-25T17:29:30.000Z","dependencies_parsed_at":"2022-11-02T11:16:49.414Z","dependency_job_id":null,"html_url":"https://github.com/Basster/silex-simple-swagger-provider","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Basster%2Fsilex-simple-swagger-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Basster%2Fsilex-simple-swagger-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Basster%2Fsilex-simple-swagger-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Basster%2Fsilex-simple-swagger-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Basster","download_url":"https://codeload.github.com/Basster/silex-simple-swagger-provider/tar.gz/refs/heads/silex-2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251689856,"owners_count":21627997,"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":[],"created_at":"2024-11-17T11:34:45.704Z","updated_at":"2025-04-30T11:25:28.204Z","avatar_url":"https://github.com/Basster.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"silex-simple-swagger-provider\n======================\n\n[![Build Status](https://travis-ci.org/Basster/silex-simple-swagger-provider.svg?branch=master)](https://travis-ci.org/Basster/silex-simple-swagger-provider) \n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Basster/silex-simple-swagger-provider/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Basster/silex-simple-swagger-provider/?branch=master)\n[![Code Coverage](https://scrutinizer-ci.com/g/Basster/silex-simple-swagger-provider/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Basster/silex-simple-swagger-provider/?branch=master)\n\n[silex-simple-swagger-provider](https://github.com/Basster/silex-simple-swagger-provider) is a silex service provider that\nintegrates [swagger-php](https://github.com/zircote/swagger-php) (Version 2) into [silex](https://github.com/fabpot/Silex).  This\nservice provider adds routes for generating and exposing a swagger defintion based on swagger-php annotations.  The\nswagger definition can then be used with [swagger-ui](https://github.com/wordnik/swagger-ui).\n\nThis library is strongly inspired by Jason Desrosiers [silex-swagger-provider](https://github.com/jdesrosiers/silex-swagger-provider)\nbut fully rewritten to meet the needs of [swagger-php](https://github.com/zircote/swagger-php) (Version 2)\n\nInstallation for Silex 2\n------------------------\nInstall the silex-swagger-provider using [composer](http://getcomposer.org/).\n\n```bash\ncomposer require basster/silex-simple-swagger-provider:^2.0\n```\n\nParameters\n----------\n* **swagger.servicePath**: The path to the classes that contain your swagger annotations.\n* **swagger.excludePath**: A string path or an array of paths to be excluded when generating annotations.\n* **swagger.apiDocPath**: The URI that will be used to access the swagger definition. Defaults to `/api/api-docs`.\n* **swagger.cache**: An array of caching options that will be passed to Symfony 2's `Response::setCache` method.\n\nServices\n--------\n* **swagger**: An instance of `Swagger\\Annotations\\Swagger`.  It's the already parsed swagger annotation tree.\n\nRegistering\n-----------\n```php\n$app-\u003eregister(new Basster\\Silex\\Provider\\Swagger\\SwaggerProvider(), [\n    \"swagger.servicePath\" =\u003e __DIR__ . \"/path/to/your/api\",\n]);\n```\nUsage\n-----\nThe following routes are made available by default\n* `GET /api/api-docs`: Get the list of resources\n\nThe results of the swagger definition file is not cached internally.  Instead, the routes that are created are designed\nto work with an HTTP cache such as a browser cache or reverse proxy.  You can configure how you want to your service\ncached using the `swagger.cache` parameter.  By default, no caching will be done.  Read about\n[HTTP caching](http://symfony.com/doc/current/book/http_cache.html) in Symfony for more information about how to\ncustomize caching behavior.  The following example will allow the service definition file to be cached for 5 days.\n\n```php\n$app[\"swagger.cache\"] = [\n    \"max_age\": \"432000\", // 5 days in seconds\n    \"s_maxage\": \"432000\", // 5 days in seconds\n    \"public\": true,\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasster%2Fsilex-simple-swagger-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasster%2Fsilex-simple-swagger-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasster%2Fsilex-simple-swagger-provider/lists"}