aymard-pro/cake-swagger

Swagger plugin for CakePHP v3

cake-swagger

, _(*1)

CakePHP 3.x plugin that dinamically adds auto-generated Swagger documentation to your projects using swagger-php and swagger-ui 3.x, _(*2)

Requirements

• CakePHP 3.0+
• Some swagger-php annotation knowledge

Installation

1. Install the plugin using composer:, _(*3)

   composer require aymard-pro/cake-swagger:dev-master
   

2. To enable the plugin either run the following command:, _(*4)

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

   or manually add the following line to your config/bootstrap.php file:, _(*5)

   Plugin::load('CakeSwagger', ['routes' => true, 'bootstrap' => true]);
   

3. Create the configuration file /config/cake-swagger.php if not exists. See #Configuration section, _(*6)

4. Browsing to http://your_app_uri/api/ui should now produce the Swagger-UI interface:, _(*7)

   , _(*8)

Configuration

All configuration for this plugin is done through the /config/cake-swagger.php configuration file. Full example below., _(*9)

<?php

return [
    'CakeSwagger' => [
        'ui' => [
            'title' => 'CakePHP Swagger plugin'
        ],
        'route' => [
            'path' => '/api'
        ],
        'directory' => [],
        'exclude' => []
    ]
];

Additional Reading

• The Swagger Specification
• PHP Annotation Examples
• Swagger Document Checklist

Contribute

I'm trying to make this plugin very testable for the community. Your ideas and suggestions are welcome. Create an issue here., _(*10)

NB

This plugin was originally forked from alt3/cakephp-swagger based on the Swagger-UI 2.2.3, _(*11)