devin345458/cake-swagger

CakePHP v4的Swagger插件

维护者

详细信息

github.com/Devin345458/cake-swagger

源代码

安装量: 1,776

依赖关系: 0

建议者: 0

安全性: 0

星星: 0

关注者: 0

分支: 5

类型:cakephp-plugin

4.0.6 2020-04-30 18:44 UTC

Requires

Requires (Dev)

MIT fa2c5078e50b5e77c314418c4a3876784a68b2db

  • Devin345458 <hollistergraham123.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-29 05:36:16 UTC

README

License

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

需求

安装

  1. 使用composer安装插件

    composer require devin345458/cake-swagger:dev-master

  2. 要启用插件，运行以下命令之一：

    bin/cake plugin load CakeSwagger

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

    Application::load('CakeSwagger');

  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' => []
	]
];

其他阅读材料

贡献

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

注意

此插件最初是基于Swagger-UI 2.2.3从alt3/cakephp-swagger分支。