evandarwin/jsend

PHP项目的基本JSend接口。

维护者

详情

github.com/EvanDarwin/JSend

源代码

问题

安装次数: 13,071

依赖: 1

建议者: 0

安全: 0

星星: 1

关注者: 2

分支: 0

开放问题: 0

类型：项目

2.0.1 2020-01-29 03:27 UTC

Requires

  • php: >=7.2.0

MIT b1182812a2917142a1a00e173fcc07ccf6b7033a

jsonjsend

This package is auto-updated.

Last update: 2024-09-29 03:39:49 UTC

README

Build Status Code Climate Test Coverage

一个小巧的PHP库，根据原始的JSend规范生成JSON响应。

规范已稍作修改，以适应API使用，其中现在可选的code和message属性。这两个属性都旨在易于阅读，如果不提供则不会显示。

2.x版本需要PHP 7.2+ 如果您需要支持PHP >= 5.6，请使用1.x分支。

安装

使用Composer安装JSend

$ composer require evandarwin/jsend

用法

您可以像这样使用JSend

<?php
use EvanDarwin\JSend\JSendBuilder;

$builder = new JSendBuilder();

// This will return a JSendResponse
$response = $builder->success()
                    ->data(['id' => 3])
                    ->code(12)
                    ->message("Hello")
                    ->get();

// Output the JSON
header('Content-Type: application/json');
echo $response->getResponse();

响应将形成如下

{
  "status": "success",
  "message": "Hello",
  "code": 12,
  "data": {
    "id": 3
  }
}

其他状态包括

  • fail - 当用户做了错误的事情，并且他们应该在再次请求之前修复它。
  • error - 内部服务器错误或不是用户请求问题的东西
<?php
use EvanDarwin\JSend\JSendBuilder;

// These alternatives statuses can be set like so
$builder = new JSendBuilder();

// For failure
$builder->failed()->get();

// For error
$builder->error()->get();

许可证

在MIT许可证下发布。有关信息，请参阅LICENSE文件。