gtk / gapi
一个针对 Laravel 和 Lumen 框架的 RESTful API 包。
这个包的官方仓库似乎已经消失了,因此该包已被冻结。
v0.2.0
2019-03-06 10:05 UTC
Requires
- php: >=5.4.0
- illuminate/contracts: ~5.0
- illuminate/database: ~5.0
- illuminate/http: ~5.0
- illuminate/support: ~5.0
- league/fractal: ^0.13.0
Requires (Dev)
- mockery/mockery: 0.9.9
- phpunit/phpunit: ~4.0
Suggests
- barryvdh/laravel-cors: Allow you to send Cross-Origin Resource Sharing headers with ACL-style per-url configuration.
- tymon/jwt-auth: Protect your API with JSON Web Tokens.
This package is not auto-updated.
Last update: 2024-06-08 18:10:55 UTC
README
Gapi 提供了一种简单、方便的方式来正确处理您的 API 响应。
安装
通过 composer 安装 - 编辑您的 composer.json
文件以添加此包。
"require": {
"gtk/gapi": "dev-master"
}
然后,在您的终端中运行 composer update
以将其拉取。
完成以上步骤后,您需要将服务提供者添加到您的 config/app.php
文件中的 providers 数组中,如下所示
'providers' => [
// Other service providers...
Gtk\Gapi\GapiServiceProvider::class,
],
如果您正在使用 Lumen,请在 bootstrap/app.php
文件中注册 Gtk\Gapi\GapiServiceProvider
// $app->register(App\Providers\AppServiceProvider::class);
// $app->register(App\Providers\AuthServiceProvider::class);
// $app->register(App\Providers\EventServiceProvider::class);
$app->register(Gtk\Gapi\GapiServiceProvider::class);
基本用法
接下来,您可以使用 api_response()
辅助函数为您的应用程序响应 API 结果。
class FooController extends Controlelr
{
// some code ...
return api_response()->json([
'success' => true,
]);
}
许可证
Gapi 是开源软件,许可协议为 MIT 许可协议。