{"id":43048998,"url":"https://github.com/aymardkouakou/cake-swagger","last_synced_at":"2026-01-31T10:11:39.014Z","repository":{"id":49485643,"uuid":"88386965","full_name":"aymardkouakou/cake-swagger","owner":"aymardkouakou","description":"Swagger 3.x plugin for CakePHP v3","archived":false,"fork":false,"pushed_at":"2021-06-16T18:15:00.000Z","size":419,"stargazers_count":0,"open_issues_count":2,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-27T16:11:19.017Z","etag":null,"topics":["aymard","aymard-pro","cakephp3","php","pro","swagger3"],"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/aymardkouakou.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":"2017-04-16T02:48:48.000Z","updated_at":"2021-06-16T18:15:04.000Z","dependencies_parsed_at":"2022-08-26T08:01:42.283Z","dependency_job_id":null,"html_url":"https://github.com/aymardkouakou/cake-swagger","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/aymardkouakou/cake-swagger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aymardkouakou%2Fcake-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aymardkouakou%2Fcake-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aymardkouakou%2Fcake-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aymardkouakou%2Fcake-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aymardkouakou","download_url":"https://codeload.github.com/aymardkouakou/cake-swagger/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aymardkouakou%2Fcake-swagger/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28937887,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T08:53:31.997Z","status":"ssl_error","status_checked_at":"2026-01-31T08:51:38.521Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["aymard","aymard-pro","cakephp3","php","pro","swagger3"],"created_at":"2026-01-31T10:11:38.553Z","updated_at":"2026-01-31T10:11:39.009Z","avatar_url":"https://github.com/aymardkouakou.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cake-swagger\n\n[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.txt)\n\n`CakePHP 3.x` plugin that dinamically adds auto-generated Swagger documentation to your projects using `swagger-php` and `swagger-ui 3.x`\n\n## Requirements\n\n* CakePHP 3.0+\n* Some [swagger-php](https://github.com/zircote/swagger-php) annotation knowledge\n\n## Installation\n\n1. Install the plugin using composer:\n\n    ```bash\n    composer require aymard-pro/cake-swagger:dev-master\n    ```\n\n2. To enable the plugin either run the following command:\n\n    ```bash\n    bin/cake plugin load CakeSwagger --routes --bootstrap\n    ```\n\n    or manually add the following line to your `config/bootstrap.php` file:\n\n    ```bash\n    Plugin::load('CakeSwagger', ['routes' =\u003e true, 'bootstrap' =\u003e true]);\n    ```\n\n3. Create the configuration file `/config/cake-swagger.php` if not exists. See #Configuration section\n\n4. Browsing to `http://your_app_uri/api/ui` should now produce the\n[Swagger-UI](http://petstore.swagger.io/) interface:\n\n    ![Default UI index](http://2434zd29misd3e4a4f1e73ki.wpengine.netdna-cdn.com/wp-content/uploads/2017/04/swagger-UI-e1491843286926.png)\n\n## Configuration\n\nAll configuration for this plugin is done through the `/config/cake-swagger.php`\nconfiguration file. Full example below.\n\n```php\n\u003c?php\n\nreturn [\n\t'CakeSwagger' =\u003e [\n\t\t'ui' =\u003e [\n\t\t\t'title' =\u003e 'CakePHP Swagger plugin'\n\t\t],\n\t\t'route' =\u003e [\n\t\t\t'path' =\u003e '/api'\n\t\t],\n\t\t'directory' =\u003e [],\n\t\t'exclude' =\u003e []\n\t]\n];\n```\n\n## Additional Reading\n\n- [The Swagger Specification](https://github.com/swagger-api/swagger-spec)\n- [PHP Annotation Examples](https://github.com/zircote/swagger-php/tree/master/Examples)\n- [Swagger Document Checklist](http://apievangelist.com/2015/06/15/my-minimum-viable-definition-for-a-complete-swagger-api-definition/)\n\n## Contribute\n\nI'm trying to make this plugin very testable for the community. Your ideas and suggestions are welcome.\n[Create an issue here.](https://github.com/aymard-pro/cake-swagger/issues/new)\n\n## NB\n\nThis plugin was originally forked from [alt3/cakephp-swagger](https://github.com/alt3/cakephp-swagger) based on the `Swagger-UI 2.2.3`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faymardkouakou%2Fcake-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faymardkouakou%2Fcake-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faymardkouakou%2Fcake-swagger/lists"}