README

这是API端点测试和调试的辅助方法集合。

安装

您可以通过composer安装此包

composer require stephenjude/api-test-helper --dev

用法

namespace Tests\Apis;

use App\Models\User;
use Tests\TestCase;
use Stephenjude\ApiTestHelper\WithApiHelper;

class UserApiTest extends TestCase
{
    use WithApiHelper;

    /*
    * @test
    */
    public function testGetAllUsers()
    {
        $actualUsers = User::all();

        $this->response = $this->getJson('/users');

        // Assert response is 200
        $this->response->assertOk();

        // Dump api data to the console
        $this->dumpApiData();

        // Write api data to the log file
        $this->logApiData();

        // Return a decoded api response data
        $responseData = $this->decodeApiResponse();

        // Assert API data is a collection 
        $this->assertApiResponseCollection($actualUsers);
    }
}

可用的辅助方法

方法	描述
`decodeApiResponse()`	返回解码后的API响应数据。
`dumpApiData()`	将API响应数据输出到控制台。
`logApiData()`	将API响应数据写入日志文件。
`assertApiSuccess()`	断言API响应数据是成功的：[成功 => true]。
`assertApiResponse($actualData)`	断言API响应数据与实际数据项相同。
`assertApiResponseCollection($actualData)`	断言API响应数据与实际集合项相同。