{"id":487,"date":"2025-08-28T10:40:39","date_gmt":"2025-08-28T10:40:39","guid":{"rendered":"https:\/\/1v0.net\/blog\/?p=487"},"modified":"2025-08-28T10:40:41","modified_gmt":"2025-08-28T10:40:41","slug":"how-to-write-feature-tests-in-laravel-for-apis","status":"publish","type":"post","link":"https:\/\/1v0.net\/blog\/how-to-write-feature-tests-in-laravel-for-apis\/","title":{"rendered":"How to Write Feature Tests in Laravel for APIs"},"content":{"rendered":"\n

How to Write Feature Tests in Laravel for APIs<\/strong><\/h2>\n\n\n\n

Feature tests validate full request lifecycles\u2014routes, middleware, controllers, policies, database, and JSON responses. In this guide, you\u2019ll create API endpoints, secure them, and write expressive feature tests that assert status codes, payload structure, and side effects.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Prerequisites and Setup<\/strong><\/h2>\n\n\n\n

Ensure you have a working API stack and database test environment. If you\u2019re building a token-based API, consider first reading How to Build a REST API with Laravel 12 & Sanctum<\/a> and Securing Laravel APIs with Sanctum: Complete Guide<\/a>.<\/p>\n\n\n

php artisan make:model Post -mf\nphp artisan make:controller Api\/PostController --api\nphp artisan make:test<\/span> Api\/PostApiTest<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
This scaffolds a Post<\/code> model, migration, factory, an API controller, and a feature test class to exercise the HTTP layer.<\/p>\n\n\n\n
<\/div>\n\n\n\n
Create Routes and Controller Methods<\/strong><\/h2>\n\n\n\n
Define minimal endpoints for listing and creating posts. These examples assume you\u2019ll protect store<\/code> with auth middleware (e.g., Sanctum).<\/p>\n\n\n
\/\/ routes\/api.php<\/span>\nuse<\/span> Illuminate<\/span>\\Support<\/span>\\Facades<\/span>\\Route<\/span>;\nuse<\/span> App<\/span>\\Http<\/span>\\Controllers<\/span>\\Api<\/span>\\PostController<\/span>;\n\nRoute::get('\/posts'<\/span>, [PostController::class, 'index'<\/span>]);\nRoute::middleware('auth:sanctum'<\/span>)->post('\/posts'<\/span>, [PostController::class, 'store'<\/span>]);<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
GET \/posts<\/code> is public for demonstration; POST \/posts<\/code> requires authentication via auth:sanctum<\/code>. Adjust to your security needs.<\/p>\n\n\n
\/\/ app\/Http\/Controllers\/Api\/PostController.php<\/span>\nnamespace<\/span> App<\/span>\\Http<\/span>\\Controllers<\/span>\\Api<\/span>;\n\nuse<\/span> App<\/span>\\Http<\/span>\\Controllers<\/span>\\Controller<\/span>;\nuse<\/span> App<\/span>\\Models<\/span>\\Post<\/span>;\nuse<\/span> Illuminate<\/span>\\Http<\/span>\\Request<\/span>;\nuse<\/span> Illuminate<\/span>\\Http<\/span>\\Response<\/span>;\n\nclass<\/span> PostController<\/span> extends<\/span> Controller<\/span>\n<\/span>{\n    public<\/span> function<\/span> index<\/span>()<\/span>\n    <\/span>{\n        return<\/span> response()->json([\n            'data'<\/span> => Post::latest()->select(['id'<\/span>,'title'<\/span>,'body'<\/span>])->paginate(10<\/span>)\n        ]);\n    }\n\n    public<\/span> function<\/span> store<\/span>(Request $request)<\/span>\n    <\/span>{\n        $validated = $request->validate([\n            'title'<\/span> => ['required'<\/span>,'string'<\/span>,'max:120'<\/span>],\n            'body'<\/span>  => ['required'<\/span>,'string'<\/span>],\n        ]);\n\n        $post = Post::create($validated);\n\n        return<\/span> response()->json([\n            'message'<\/span> => 'Created'<\/span>,\n            'data'<\/span>    => [\n                'id'<\/span>    => $post->id,\n                'title'<\/span> => $post->title,\n                'body'<\/span>  => $post->body,\n            ],\n        ], Response::HTTP_CREATED);\n    }\n}<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
\/\/ database\/migrations\/xxxx_xx_xx_create_posts_table.php<\/span>\nuse<\/span> Illuminate<\/span>\\Database<\/span>\\Migrations<\/span>\\Migration<\/span>;\nuse<\/span> Illuminate<\/span>\\Database<\/span>\\Schema<\/span>\\Blueprint<\/span>;\nuse<\/span> Illuminate<\/span>\\Support<\/span>\\Facades<\/span>\\Schema<\/span>;\n\nreturn<\/span> new<\/span> class<\/span> extends<\/span> Migration<\/span> <\/span>{\n    public<\/span> function<\/span> up<\/span>()<\/span>: void<\/span> <\/span>{\n        Schema::create('posts'<\/span>, function<\/span> (Blueprint $table)<\/span> <\/span>{\n            $table->id();\n            $table->string('title'<\/span>);\n            $table->text('body'<\/span>);\n            $table->timestamps();\n        });\n    }\n    public<\/span> function<\/span> down<\/span>()<\/span>: void<\/span> <\/span>{\n        Schema::dropIfExists('posts'<\/span>);\n    }\n};<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
This migration creates a minimal posts<\/code> table. Keep columns concise to make focused tests faster and more reliable.<\/p>\n\n\n
\/\/ database\/factories\/PostFactory.php<\/span>\nnamespace<\/span> Database<\/span>\\Factories<\/span>;\n\nuse<\/span> Illuminate<\/span>\\Database<\/span>\\Eloquent<\/span>\\Factories<\/span>\\Factory<\/span>;\n\nclass<\/span> PostFactory<\/span> extends<\/span> Factory<\/span>\n<\/span>{\n    public<\/span> function<\/span> definition<\/span>()<\/span>: array<\/span>\n    <\/span>{\n        return<\/span> [\n            'title'<\/span> => $this<\/span>->faker->sentence(6<\/span>),\n            'body'<\/span>  => $this<\/span>->faker->paragraph(),\n        ];\n    }\n}<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
<\/div>\n\n\n\n
Writing Feature Tests for API Endpoints<\/strong><\/h2>\n\n\n\n
Below is the complete test suite for a small Posts API. Right after the code, you\u2019ll find a line-by-line breakdown explaining every import, trait, method, assertion, and why it matters.<\/p>\n\n\n
\/\/ tests\/Feature\/Api\/PostApiTest.php<\/span>\nnamespace<\/span> Tests<\/span>\\Feature<\/span>\\Api<\/span>;\n\nuse<\/span> Tests<\/span>\\TestCase<\/span>;\nuse<\/span> App<\/span>\\Models<\/span>\\User<\/span>;\nuse<\/span> App<\/span>\\Models<\/span>\\Post<\/span>;\nuse<\/span> Illuminate<\/span>\\Foundation<\/span>\\Testing<\/span>\\RefreshDatabase<\/span>;\n\nclass<\/span> PostApiTest<\/span> extends<\/span> TestCase<\/span>\n<\/span>{\n    use<\/span> RefreshDatabase<\/span>;\n\n    public<\/span> function<\/span> test_can_list_posts_as_json<\/span>()<\/span>\n    <\/span>{\n        Post::factory()->count(3<\/span>)->create();\n\n        $response = $this<\/span>->getJson('\/api\/posts'<\/span>);\n\n        $response->assertOk()\n                 ->assertJsonStructure(['data'<\/span> => ['data'<\/span> => [['id'<\/span>,'title'<\/span>,'body'<\/span>]]]]);\n    }\n\n    public<\/span> function<\/span> test_cannot_create_post_when_unauthenticated<\/span>()<\/span>\n    <\/span>{\n        $response = $this<\/span>->postJson('\/api\/posts'<\/span>, [\n            'title'<\/span> => 'Hello'<\/span>,\n            'body'<\/span>  => 'World'<\/span>,\n        ]);\n\n        $response->assertUnauthorized();\n    }\n\n    public<\/span> function<\/span> test_authenticated_user_can_create_post<\/span>()<\/span>\n    <\/span>{\n        $user = User::factory()->create();\n\n        $response = $this<\/span>->actingAs($user, 'sanctum'<\/span>)\n                          ->postJson('\/api\/posts'<\/span>, [\n                              'title'<\/span> => 'My Title'<\/span>,\n                              'body'<\/span>  => 'Body text'<\/span>,\n                          ]);\n\n        $response->assertCreated()\n                 ->assertJsonPath('data.title'<\/span>, 'My Title'<\/span>);\n\n        $this<\/span>->assertDatabaseHas('posts'<\/span>, ['title'<\/span> => 'My Title'<\/span>]);\n    }\n\n    public<\/span> function<\/span> test_validation_errors_are_returned<\/span>()<\/span>\n    <\/span>{\n        $user = User::factory()->create();\n\n        $response = $this<\/span>->actingAs($user, 'sanctum'<\/span>)\n                          ->postJson('\/api\/posts'<\/span>, [\n                              'title'<\/span> => ''<\/span>,   \/\/ invalid<\/span>\n                              'body'<\/span>  => ''<\/span>,   \/\/ invalid<\/span>\n                          ]);\n\n        $response->assertStatus(422<\/span>)\n                 ->assertJsonValidationErrors(['title'<\/span>,'body'<\/span>]);\n    }\n}<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Namespace & Imports<\/strong><\/p>\n\n\n\n
Factories provide quick, expressive test data. For deeper patterns, see Using Laravel Factories and Seeders for Test Data<\/a>.<\/p>\n\n\n\n
The controller returns predictable JSON structures so your tests can assert both shape and content. For clean response formatting in larger projects, also see How to Use Eloquent API Resources for Clean APIs<\/a>.<\/p>\n\n\n