通过 
搜索
搜索freefri / cake-rest-api
CakePHP Rest API
0.5.18
2024-08-07 07:55 UTC
Requires
- php: >=7.4 || >=8.0
- ext-json: *
- ext-mbstring: *
- bshaffer/oauth2-server-php: ~1.14
- cakephp/cakephp: ^4.4
- cakephp/migrations: ^3.2
- composer/composer: ^2.0
- eduplex-api/cake-api-swagger: ^0.1.4
- symfony/service-contracts: ^2.5.3
Requires (Dev)
- cakephp/cakephp-codesniffer: 4.*
- freefri/cake-rest-api-fake-app: ^0.1.2
- phpunit/phpunit: ~8.5.0 || ^9.3 || ^10.1
Suggests
- phpstan/phpstan: PHPStan focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code.
- dev-main
- 0.5.18
- 0.5.17
- 0.5.16
- 0.5.15
- 0.5.14
- 0.5.13
- 0.5.12
- 0.5.11
- 0.5.10
- 0.5.9
- 0.5.8
- 0.5.7
- 0.5.6
- 0.5.5
- 0.5.4
- 0.5.3
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.4
- 0.4.3
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.26
- 0.3.25
- 0.3.24
- 0.3.23
- 0.3.22
- 0.3.21
- 0.3.20
- 0.3.19
- 0.3.18
- 0.3.17
- 0.3.16
- 0.3.15
- 0.3.14
- 0.3.13
- 0.3.12
- 0.3.11
- 0.3.10
- 0.3.9
- 0.3.8
- 0.3.7
- 0.3.6
- 0.3.5
- 0.3.4
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- 0.2.0
- 0.1.9
- 0.1.8
- 0.1.7
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
This package is auto-updated.
Last update: 2024-09-07 14:49:44 UTC
README
CakePHP 4.x 的 Rest API
配置
-
某些配置可以使用环境变量完成（在项目中搜索
env(以查找用法）。 -
当与插件一起工作时，某些配置可以从主配置（
config/app.php文件）中完成）。- 使用键
Swagger是可选的，但可以帮助自定义某些目录（搜索read('Swagger以获取详细信息）。 - 从主
App配置的兄弟配置使用插件的命名空间，后跟单词Plugin。
- 使用键
例如，如果您的插件命名空间为 Example，请创建以下配置文件
return [
'debug' => false,
'App' => [ ... ],
'Swagger' => [ ... ]
'ExamplePlugin' => [
'tablePrefix' => 'example_',
'routePath' => '/api/v1',
],
];
以下配置可以使用
tablePrefix:（可选）如果您想为数据库表添加前缀，例如myplugin_users。可以为空字符串。routePath: 为插件中所有路由的路径定义
Swagger
为了使包含 openapi 描述的 swagger UI 可用，必须创建一个新的控制器 SwaggerJsonController，并定义相应的路由。可以在该控制器中重写 getContent 方法，以添加对主规范信息（标题、描述、版本等）的自定义。Swagger 生成配置可以如上所述的配置部分进行配置。
在任何控制器中测试函数 $this->skipNextRequestInSwagger() 可以用来不添加下一个请求。
许可
本站源代码受 MIT 许可 许可，可在 LICENSE 文件中找到。