README

CakePHP 3.x 插件，利用 swagger-php 和 swagger-ui 3.x 动态为项目添加自动生成的 Swagger 文档

要求

CakePHP 3.0+
一些 swagger-php 注解知识

安装

使用 composer 安装插件

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

要启用插件，可以运行以下命令

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

或者手动将以下行添加到您的 config/bootstrap.php 文件中

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

如果不存在，则创建配置文件 /config/cake-swagger.php。参见 #配置部分
访问 http://your_app_uri/api/ui 应该现在会显示 Swagger-UI 界面

配置

本插件的全部配置都通过 /config/cake-swagger.php 配置文件完成。以下是一个完整的示例。

<?php

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

进一步阅读

贡献

我正在努力使这个插件对社区非常易于测试。欢迎您的想法和建议。在此创建问题。

注意

此插件最初是从 alt3/cakephp-swagger 分支出来的，基于 Swagger-UI 2.2.3

aymard-pro / cake-swagger

维护者

详细信息

README

要求

安装

配置

进一步阅读

贡献

注意