Asserting a JSON Response Structure in Laravel

Last updated on by

Asserting a JSON Response Structure in Laravel image

When writing tests for API responses in Laravel, it can be useful to validate the structure of the response. Laravel has the fluent assertJson() method, which you can use to verify JSON values in a given test response:

it('Returns Arizona sports teams', function () {
$this->get('api/teams/arizona')
->assertJson(function (AssertableJson $json) {
$json->has('teams', 3);
$json->has('teams.0', function (AssertableJson $json) {
$json
->where('name', 'Phoenix Suns')
->etc();
});
});
});

Given the above test, here's a static example of the JSON data:

{
"teams": [
{
"name": "Phoenix Suns",
"sport": "Basketball"
},
{
"name": "Arizona Cardinals",
"sport": "Football"
},
{
"name": "Arizona Diamondbacks",
"sport": "Baseball"
}
]
}

Our test validates that three teams are listed in Arizona and that the name property exists on the first record. That's excellent for validating the actual values to sample the response using the powerful JSON assertion APIs in Laravel. To complement those assertions, we can also validate the general structure of the whole response:

$response->assertJsonStructure([
'teams' => [
'*' => ['name', 'sport'],
],
]);

One caveat to the assertJsonStucture() assertion: if we add a new key in the future, this test will continue to pass. If you require more exactness, you might need to reach for the assertExactJson(). For just generalizing a JSON structure to ensure specific properties exist in the response, assertJsonStructure() can give you confidence that the entire structure contains properties you expect.

If you need more extensive assertions around the structure of the JSON, you might also want to reach for whereType() and whereAllType() assertions. Given our earlier example, you could validate the types in your JSON responses using the following:

$response->assertJson(function (AssertableJson $json) {
$json->has('teams', 3);
$json->has('teams.0', function (AssertableJson $json) {
$json->whereAllType([
'name' => 'string',
'sport' => 'string',
]);
});
});

Using whereAllType requires us to define types for each and every key in the teams item, unless you use the above with ->etc():

$json->whereAllType([
'name' => 'string',
// 'sport' => 'string',
])->etc();

As mentioned, the above code doesn't assert the whole response and assumes the other teams have the same structure. You could assert each team in the array, and even use Eloquent factory data to validate the response values match. Typically, combining the above assertions will ensure you have the expected JSON response shape, and you can mix in more complicated assertions where needed. See the Laravel Documentation for more examples and useful JSON assertions.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
A Resize Plugin for Alpine.js image

A Resize Plugin for Alpine.js

Read article
How to Migrate MySQL from DBngin to Laravel Herd image

How to Migrate MySQL from DBngin to Laravel Herd

Read article
Learn to master Query Scopes in Laravel image

Learn to master Query Scopes in Laravel

Read article
How to Redirect Uppercase URLs to Lowercase with Laravel Middleware image

How to Redirect Uppercase URLs to Lowercase with Laravel Middleware

Read article
PHP 8.4 Alpha 1 is now out! image

PHP 8.4 Alpha 1 is now out!

Read article
Generics Added to Eloquent Builder in Laravel 11.15 image

Generics Added to Eloquent Builder in Laravel 11.15

Read article