antare74 / response-formatter
该软件包用于将响应以标准化的方式格式化为JSON格式,以帮助前端理解响应并轻松处理API响应。
v0.1.1-alpha
2022-07-01 09:03 UTC
Requires
- php: ^7.0.33|^8.0
This package is auto-updated.
Last update: 2024-09-20 08:12:10 UTC
README
Laravel响应格式化器
我创建此软件包是为了使从控制器格式化响应更加容易。我已经在我的项目中使用了此软件包,希望您也能喜欢它!
📝 目录
🧐 关于
这是一个简单的软件包,允许您以一致的方式格式化响应。这可能对您的API或前端很有用。
🏁 入门
这些说明将帮助您开始项目。
先决条件
您需要安装哪些软件以及如何安装它们。
composer
Laravel Version: >= 5.8
安装
一系列分步示例,告诉您如何运行开发环境。
composer require antare74/response-formatter
🎈 用法
示例用法。
<?php
use Illuminate\Support\Facades\Route;
use Antare74\ResponseFormatter\Format;
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/
Route::get('/success', function () {
return Format::success([
'name' => 'Antare74',
'age' => '74',
'address' => 'Jakarta',
], 'Success Message');
});
Route::get('/error', function () {
return Format::error([
'my_error_data' => 'Error Message',
], 'Error Message', 500);
});
示例成功响应。
{
"meta": {
"code": 200,
"status": "success",
"message": "Success Message",
"is_paginated": false
},
"pagination": [
],
"data": {
"name": "Antare74",
"age": "74",
"address": "Jakarta"
}
}
示例错误响应。
{
"meta": {
"code": 500,
"status": "error",
"message": "Error Message",
"is_paginated": false
},
"data": {
"my_error_data": "Error Message"
}
}
✍️ 作者
- @antare74 - IDK
请参阅参与此项目的贡献者列表。