README

这是为了创建容易的API响应，用于我的项目。是的，我有点懒，总是重复相同的代码。感谢Composer让PHP代码更容易编写。XD 当然，我会在将来改变这个！ : )

先决条件 📋

您需要在您的计算机上安装Composer。

安装 🔧

您需要将包要求到您的项目中。

composer require agrandesr/response

接下来，您可以在代码中使用两个类Response和GlobalResponse，但忽略第一个。我建议您（和我）只使用GlobalResponse，它更酷，您可以在代码的任何地方使用... 无需实例化！抱歉我的英语... : /

要使用它，只需在您的线程开始时使用。但我肯定您已经做到了！ ;)

require './vendor/autoload.php';

接下来，要使用它，只需在您想要使用的地方使用GlobalResponse。

use AgrandesR\GlobalResponse;
//Or if you want an alias
use AgrandesR\GlobalResponse as Response;
//Or more funny..
use AgrandesR\GlobalResponse as CoolResponse; // ji ji ji 😝

如何开始 🚀

全局响应的想法是简化在PHP中创建的API的代码对客户端的响应。第一个版本是为JSON API创建的，但我的想法是使用我的其他Composer包 A.G.R (api-generator-router) 来改进这个类。

您只需要担心逻辑。全局响应为您和每个使用项目的标准响应提供标准。您只需要关心代码的逻辑，而不用担心如何返回数据等小问题。

同时，您可以轻松地在响应中添加警告和错误。

但是，如何开始呢？ 🤔

您只需快速阅读以下方法，了解如何使用。基本上有两种类型的函数。向响应添加信息的函数和渲染函数（显示和showData）。

请，阅读很容易。它们都是静态方法，您可以在不同的文件中使用，而无需考虑如何共享Response对象。当您想要结束线程并发送响应时，只需使用为该目的创建的方法之一。

显示函数

首先，从结尾开始。当您想要打印响应时非常简单。只需使用以下函数之一。

显示

GlobalResponse::show();

没有数据或元数据的响应示例

{
    "success":true,
    "code":200
}

显示数据

showData 函数只显示数据内容。这意味着对于客户端用户，所有警告、状态码或响应的元数据都被隐藏。

GlobalResponse::addData('key','value');

GlobalResponse::showData();

只有数据响应的示例

{
    "key":"value"
}

额外内容

版本控制：📌

有关所有可用版本，请参阅此存储库中的标签。

作者 ✒️

提及自项目开始以来帮助建立项目的所有人

A.Grandes.R - 主要工作者 - AGrandesR

许可证 📄

本项目受MIT许可证约束 - 有关详细信息，请参阅 LICENSE 文件。

感谢：🎁

Villanuevand 为其出色的文档模板 😊

agrandesr / response

维护者

详细信息