JSON Response

Testing Is Documentation

tests/Http/JsonResponseTest.php

QueryPHP 针对 API 开发可以直接返回一个 \Leevel\Http\JsonResponse 响应对象。

Uses

<?php

use Leevel\Http\JsonResponse;
use Leevel\Kernel\Utils\Api;
use Leevel\Support\IArray;
use Leevel\Support\IJson;

getEncodingOptions 获取 JSON 编码参数

public function testGetEncodingConfigs(): void
{
    $response = new JsonResponse();
    self::assertSame(JSON_UNESCAPED_UNICODE, $response->getEncodingOptions());
}

setData 设置 JSON 数据支持 JSON 编码参数

public function testSetDataWithEncodingConfigs(): void
{
    $response = new JsonResponse();

    $response->setData(['成都', 'QueryPHP']);
    self::assertSame('["成都","QueryPHP"]', $response->getContent());

    $response->setEncodingOptions(0);
    $response->setData(['成都', 'QueryPHP']);
    self::assertSame('["\u6210\u90fd","QueryPHP"]', $response->getContent());

    $response->setEncodingOptions(JSON_FORCE_OBJECT);
    $response->setData(['成都', 'QueryPHP']);
    self::assertSame('{"0":"\u6210\u90fd","1":"QueryPHP"}', $response->getContent());
}

支持 JSON 的对象

测试实现了 \Leevel\Support\IArray 的对象

namespace Tests\Http;

class JsonResponseMyArray implements IArray
{
    public function toArray(): array
    {
        return ['hello' => 'IArray'];
    }
}

测试实现了 \Leevel\Support\IJson 的对象

namespace Tests\Http;

class JsonResponseMyJson implements IJson
{
    public function toJson(?int $config = null): string
    {
        if (null === $config) {
            $config = JSON_UNESCAPED_UNICODE;
        }

        return json_encode(['hello' => 'IJson'], $config);
    }
}

测试实现了 \JsonSerializable 的对象

namespace Tests\Http;

class JsonResponseMyJsonSerializable implements \JsonSerializable
{
    public function jsonSerialize(): mixed
    {
        return ['hello' => 'JsonSerializable'];
    }
}

public function testSetEncodingConfigs(): void
{
    $response = new JsonResponse();
    $response->setData(['foo' => 'bar']);
    self::assertSame('{"foo":"bar"}', $response->getContent());

    $response->setData(new JsonResponseMyArray());
    self::assertSame('{"hello":"IArray"}', $response->getContent());

    $response->setData(new JsonResponseMyJson());
    self::assertSame('{"hello":"IJson"}', $response->getContent());

    $response->setData(new JsonResponseMyJsonSerializable());
    self::assertSame('{"hello":"JsonSerializable"}', $response->getContent());
}