taciclei/cake-swagger

CakePHP v3 的 Swagger 插件

维护者

详细信息

github.com/taciclei/cake-swagger

源代码

安装次数: 3,249

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 5

类型:cakephp-plugin

3.0.0 2019-12-06 10:03 UTC

Requires

Requires (Dev)

MIT 4513c0f8f36490df35e21a3321fed2844089e98d

  • taciclei <souza.woop@taciclei.com>

This package is not auto-updated.

Last update: 2024-09-21 09:37:35 UTC

README

License

一个 CakePHP 3.x 插件，使用 swagger-php 和 swagger-ui 3.x 动态添加自动生成的 Swagger 文档到您的项目中

要求

安装

  1. 使用 composer 安装插件

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

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

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

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

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

  3. 如果不存在，请创建配置文件 /config/cake-swagger.php。请参阅配置部分

  4. 浏览到 http://your_app_uri/api/ui 应该现在会产生 Swagger-UI 界面

    Default UI index

配置

此插件的全部配置都是通过 /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 分支的。