lucasandrade/laravel-apiresponse

JSON响应标准化库

维护者

详细信息

github.com/lucandrade/laravel-apiresponse

源代码

问题

安装: 748

依赖项: 0

建议者: 0

安全: 0

星标: 2

关注者: 2

分支: 1

开放性问题: 1

1.3 2016-06-18 17:56 UTC

Requires

Requires (Dev)

MIT 06c15e6fecc0abd47e2a5f9c7c19db1badf83032

  • Lucas Andrade de Oliveira <lucas.andrade.oliveira.woop@hotmail.com>

frameworklaravelapi responseJson Response

This package is not auto-updated.

Last update: 2024-09-23 12:08:19 UTC

README

Build Status Codacy Badge

用于 Laravel 框架的标准 API 响应

兼容性

安装

将以下行添加到您的 composer.json 文件中

"lucasandrade/laravel-apiresponse": "dev-master"

然后运行 composer update 以获取此包。

配置 - Laravel

将此行代码添加到您 config/app.php 文件中的 providers 数组中

Lucandrade\ApiResponse\ApiResponseServiceProvider::class,

将此行添加到 aliases 数组

'ApiResponse' => Lucandrade\ApiResponse\Facades\ApiResponse::class,

运行 vendor:publish 命令

php artisan vendor:publish

配置 - Lumen

从项目路径执行此命令

cp ./vendor/lucasandrade/laravel-apiresponse/src/config/apiresponse.php ./config

取消注释您的 bootstrap/app.php 文件中的以下行

\\ $app->withFacades();

在文件末尾添加此行

$app->register(Lucandrade\ApiResponse\Lumen\ApiResponeServiceProvider::class);

用法

Route::get('/api-response', function() {
	return ApiResponse::setPayload("Here's data")
		->setStatusMessage("OK")
		->setRequestCode(0)
		->get();
});

输出

{
	"status":true,
	"payload":"Here's data",
	"message":"OK",
	"completed_at":"2015-09-02 16:27:11",
	"code":0
}

要更改响应字段，请修改位于您的 config 目录中的 apiresponse.php 文件

return [
	"keys" => [
		"status" => "{statusNameField}",
		"status_message" => "{messageNameField}",
		"request_code" => "{codeNameField}",
		"payload" => "{payloadNameField}",
		"time" => "{completedAtNameField}"
	]
];

注意：请记得在您的类文件开头添加 use ApiResponse;