Testing Partial JSON Responses with Laravel

Testing Partial JSON Responses with Laravel

Laravel provides many useful helpers for testing your application and it has great support for testing HTTP testing through its fluent API.

A feature added to v5.4.10 is a new assertJsonFragment method that allows you to look for a specific fragment instead of the whole JSON response.

Laravel JSON response

Here is a quick example of a Laravel JSON response to show how this can work. Let’s say your app has a way to fetch information on a specific user:

Route::get('/api/users', function() {
    return App\User::all();
});

This returns the JSON for all the users:

// /api/user/
[
    {"id":1,"name":"Bill Murray","email":"bill.murray@example.org","created_at":"2017-02-14 01:53:04","updated_at":"2017-02-14 01:53:04"},
    {"id":2,"name":"John Doe","email":"john.doe@example.org","created_at":"2017-02-14 02:23:14","updated_at":"2017-02-14 02:23:14"}
]

Utilizing Laravel’s assertJsonFragment

Now with the new assertJsonFragment you can test it like this:

/** @test */
function test_json_response()
{
    $response = $this->json('GET', '/api/user/1');

    $response
        ->assertStatus(200)
        ->assertJsonFragment([
            'name' => 'Bill Murray',
        ]);
}

This is just another small tool available in your arsenal to make testing easier. Check out the documentation for other methods of testing JSON responses.

Filed in: Laravel 5.4 / Testing

Newsletter

Join 31,000+ others and never miss out on new tips, tutorials, and more.

Laravel News Partners

Laravel Jobs

Software Developer
Remote (US & Canada)
Alley
๐Ÿ˜Ž Laravel Developer
Remote
Jogg, Inc
Junior, Mid, and Senior Software Engineers. Laravel / Vue. Saint Petersburg, FL
Saint Petersburg, FL and Remote
ShineOn
Senior PHP Developer (Laravel)
Remote
The Interaction Design Foundation
Fullstack Laravel Engineer (Munich/Remote) ๐Ÿ’ป
Munich, Germany or Remote
AirLST GmbH