README

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

Requirements

CakePHP 3.0+
Some swagger-php annotation knowledge

Installation

Install the plugin using composer:

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

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]);

Create the configuration file /config/cake-swagger.php if not exists. See #Configuration section
Browsing to http://your_app_uri/api/ui should now produce the Swagger-UI interface:

Configuration

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

<?php

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

Additional Reading

Contribute

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

NB

This plugin was originally forked from alt3/cakephp-swagger based on the Swagger-UI 2.2.3

aymard-pro / cake-swagger

Maintainers

Details