garphild/json-api-response

通用 JSON API 的响应接口

1.0.11 2020-09-02 10:57 UTC

This package is auto-updated.

Last update: 2024-09-29 06:14:23 UTC


README

集中管理 JSON 响应。

单例。

可以有多个管理器,但为什么?

默认响应结构

{
  'status': <number>,
  'data': <array>,
  'errors': <array>
}

自定义结构

class AnotherResponseModel implements \Garphild\ApiResponse\IResponseModel {
  ...
}
$manager = \Garphild\ApiResponse\ApiResponseManager::instance();
$manager->changeResponseModel(new AnotherResponseModel());

功能

向响应添加数据

$manager->setField('name', 123);

获取当前数据

$manager->getField('name');
$manager->getData();

将数据发送到客户端

$manager->send();
$manager->finalize();

处理状态码

$manager->forbidden();
$manager->notFound();
$manager->badRequest();
$manager->terminateWithHttpCode(200);