README

###[重要] VAPI 的 V2 版本有破坏性更改，应从配置文件夹中删除 msgcode.php 并发布配置文件

目录

• 贡献
• 安装
• 演示
• [V2] (#v2)
• 许可证

贡献

贡献使这样的惊人社区和项目成为可能。相互学习、启发和创造。您所做的任何贡献都 非常受欢迎。

安装

composer require vvinners/vapi

发布配置文件到 app/config

php artisan vendor:publish --provider="VVinners\Vapi\VapiServiceProvider" --tag=config

VVinners\Vapi\VapiServiceProvider::class

演示

use VVinners\Vapi\Api;

$api = new Api;
return $api->response(["result" => true], "OK");

上面的代码将数据转换为以下 JSON 格式 并以 HTTP 200 状态 返回

{msg_code: "OK", msg: "Success", result: true}

第二个参数 "OK" 可以在下面的 msgcode.php 中更新。以下是该文件的示例数据

<?php

return [

    'response_status' => [
        // HTTP_INTERNAL_SERVER_ERROR
        '500' => [
            'ERROR' => 'Error encountered'
        ],
    
        // HTTP_OK
        '200' => [
            'OK' => 'Success',
            'USER_NOT_FOUND' => 'User not found',
        ],
    
        // HTTP_BAD_REQUEST
        '400' => [
            'INVALID_DATA_INPUT' => 'Invalid data pass to server',
            'VALIDATION_ERROR' => 'Validation error',
        ],
    
        // HTTP_UNAUTHORIZED
        '401' => [
    
        ],
    
        // HTTP_FORBIDDEN
        '403' => [
    
        ]
    ],
    'msg_code_name' => 'msg_code',
    'msg_name' => 'msg',

];

V2

• 能够在返回响应中自定义 msg_code 和 msg 列
• 更新 msgcode.php 格式

许可证

MIT 许可证 (MIT)

版权所有 (c) 2020 VVinners

特此授予任何人免费获得此软件及其相关文档文件（以下简称“软件”）的副本的权利，无限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许获得软件的人这样做，前提是符合以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供，不提供任何形式的保证，无论是明示的、暗示的，还是与特定目的和侵权无关的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论是基于合同、侵权或其他方式，无论是源于、因之或与此软件或软件的使用或其他交易有关。