PHPackages                             taciclei/cake-swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. taciclei/cake-swagger

ActiveCakephp-plugin

taciclei/cake-swagger
=====================

Swagger plugin for CakePHP v3

3.0.0(6y ago)03.3k1MITPHPPHP >=5.5

Since Apr 17Pushed 6y agoCompare

[ Source](https://github.com/taciclei/cake-swagger)[ Packagist](https://packagist.org/packages/taciclei/cake-swagger)[ RSS](/packages/taciclei-cake-swagger/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

cake-swagger
============

[](#cake-swagger)

[![License](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](LICENSE.txt)

`CakePHP 3.x` plugin that dinamically adds auto-generated Swagger documentation to your projects using `swagger-php` and `swagger-ui 3.x`

Requirements
------------

[](#requirements)

- CakePHP 3.0+
- Some [swagger-php](https://github.com/zircote/swagger-php) annotation knowledge

Installation
------------

[](#installation)

1. Install the plugin using composer:

    ```
    composer require aymard-pro/cake-swagger:dev-master
    ```
2. To enable the plugin either run the following command:

    ```
    bin/cake plugin load CakeSwagger --routes --bootstrap
    ```

    or manually add the following line to your `config/bootstrap.php` file:

    ```
    Plugin::load('CakeSwagger', ['routes' => true, 'bootstrap' => true]);
    ```
3. Create the configuration file `/config/cake-swagger.php` if not exists. See #Configuration section
4. Browsing to `http://your_app_uri/api/ui` should now produce the [Swagger-UI](http://petstore.swagger.io/) interface:

    [![Default UI index](https://camo.githubusercontent.com/7aeb412f6f2747377e2a5a04878cde89c5df5caaed1a74fecff724ce71f187de/687474703a2f2f323433347a6432396d697364336534613466316537336b692e7770656e67696e652e6e6574646e612d63646e2e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031372f30342f737761676765722d55492d65313439313834333238363932362e706e67)](https://camo.githubusercontent.com/7aeb412f6f2747377e2a5a04878cde89c5df5caaed1a74fecff724ce71f187de/687474703a2f2f323433347a6432396d697364336534613466316537336b692e7770656e67696e652e6e6574646e612d63646e2e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031372f30342f737761676765722d55492d65313439313834333238363932362e706e67)

Configuration
-------------

[](#configuration)

All configuration for this plugin is done through the `/config/cake-swagger.php`configuration file. Full example below.

```