API routes in Laravel - Step-by-Step Execution

Concept Flow - API routes

Define route in routes/api.php

↓

Laravel reads route file

↓

Match incoming API request URL and method

↓

Call controller or closure

↓

Process request logic

↓

Return JSON response

This flow shows how Laravel reads API route definitions, matches incoming requests, and returns JSON responses or errors.

Execution Sample

Laravel

Route::get('/users', function () {
    return response()->json(['name' => 'Alice']);
});

Defines a GET API route '/users' that returns a JSON object with a name.

Execution Table

Step	Action	Input	Result	Notes
1	Laravel loads routes/api.php	Route::get('/users', ...)	Route registered for GET /users	Route ready to match requests
2	Incoming request	GET /users	Route matches GET /users	Route found
3	Execute route callback	Call closure	Return JSON {"name":"Alice"}	Response prepared
4	Send response	JSON data	Client receives JSON	Request complete
5	Incoming request	POST /users	No matching route	Return 404 Not Found

💡 Execution stops when a matching route is found and response sent, or 404 if no match.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
Request Method	N/A	GET	GET	N/A
Request URL	N/A	/users	/users	N/A
Matched Route	None	GET /users	GET /users	N/A
Response Content	None	None	{"name":"Alice"}	Sent to client

Key Moments - 2 Insights

Why does a POST request to '/users' return 404 even though '/users' route exists?

Because the route is defined only for GET method, POST requests do not match and Laravel returns 404. See execution_table row 5.

What happens if the route callback returns a plain array instead of response()->json()?

Laravel automatically converts arrays to JSON responses for API routes, so the output is the same JSON. This is a Laravel convenience.

Visual Quiz - 3 Questions

Look at the execution_table, what is the response content at Step 3?

A {"name":"Alice"}

B 404 Not Found

C Empty response

D HTML page

💡 Hint

Check the 'Result' column at Step 3 in execution_table.

At which step does Laravel determine there is no matching route for POST /users?

A Step 2

B Step 4

C Step 5

D Step 3

💡 Hint

Look for the row mentioning POST /users and 404 in execution_table.

If you change the route method from GET to POST, what changes in the execution_table?

A Both GET and POST match the route

B GET /users requests return 404, POST /users requests match route

C No change, GET /users still matches

D All requests return 404

💡 Hint

Consider how HTTP methods affect route matching in execution_table rows 2 and 5.

Concept Snapshot

Laravel API routes are defined in routes/api.php
Use Route::method('url', callback) to register routes
Laravel matches incoming request method and URL to routes
If matched, runs callback and returns JSON response
If no match, returns 404 Not Found
Routes are method-specific (GET, POST, etc.)

Full Transcript

In Laravel, API routes are defined in the routes/api.php file using Route methods like Route::get or Route::post. When a request comes in, Laravel reads the route definitions and tries to find a route matching the request's URL and HTTP method. If it finds a match, it runs the associated callback or controller method, which usually returns a JSON response. If no route matches, Laravel returns a 404 Not Found error. Routes are specific to HTTP methods, so a GET route does not match POST requests. This flow ensures API requests are handled correctly and return JSON data or errors as needed.

Practice

1. What is the main purpose of defining API routes in Laravel's routes/api.php file?

easy

A. To configure middleware for user authentication

B. To define web page routes that return HTML views

C. To store database connection settings

D. To handle requests from other apps or devices and return JSON responses

Solution

1. Step 1: Understand the role of API routes

   API routes are designed to handle requests from external apps or devices, not for web pages.

2. Step 2: Identify the correct file and response type

   In Laravel, API routes are placed in routes/api.php and usually return JSON data.

3. Final Answer:

   To handle requests from other apps or devices and return JSON responses -> Option D

4. Quick Check:

   API routes = handle external requests + JSON [OK]

Hint: API routes handle external requests and return JSON [OK]

Common Mistakes:

• Confusing API routes with web routes that return HTML
• Thinking API routes are for database settings
• Assuming API routes are only for middleware

2. Which of the following is the correct syntax to define a GET API route in Laravel that returns a JSON message "Hello World"?

easy

A. Route::get('/hello', function () { return response()->json(['message' => 'Hello World']); });

B. Route::post('/hello', function () { return 'Hello World'; });

C. Route::get('/hello', function () { return view('hello'); });

D. Route::put('/hello', function () { return response('Hello World'); });

Solution

1. Step 1: Identify the HTTP verb and response type

   The question asks for a GET route that returns JSON data.

2. Step 2: Check each option's method and return

   Route::get('/hello', function () { return response()->json(['message' => 'Hello World']); }); uses GET and returns JSON with response()->json(), which is correct. Others use wrong verbs or return types.

3. Final Answer:

   Route::get('/hello', function () { return response()->json(['message' => 'Hello World']); }); -> Option A

4. Quick Check:

   GET + JSON response = Route::get('/hello', function () { return response()->json(['message' => 'Hello World']); }); [OK]

Hint: GET routes return JSON with response()->json() [OK]

Common Mistakes:

• Using POST or PUT instead of GET
• Returning plain strings instead of JSON
• Returning views in API routes

3. Given this API route in routes/api.php:

Route::post('/user', function (Illuminate\Http\Request $request) {
    return ['name' => $request->input('name'), 'age' => $request->input('age')];
});

What will be the JSON response if a POST request sends {"name": "Alice", "age": 30}?

medium

A. An error because input() is not valid

B. {"name": null, "age": null}

C. {"name": "Alice", "age": 30}

D. Empty response

Solution

1. Step 1: Understand the route and request handling

   The route accepts a POST request and reads 'name' and 'age' from the request input.

2. Step 2: Analyze the input data and response

   The POST request sends JSON with 'name' as "Alice" and 'age' as 30, so the route returns these values as JSON.

3. Final Answer:

   {"name": "Alice", "age": 30} -> Option C

4. Quick Check:

   POST input data returned as JSON = {"name": "Alice", "age": 30} [OK]

Hint: POST data accessed by input() returns JSON response [OK]

Common Mistakes:

• Assuming input() won't read JSON body
• Expecting null values if input keys missing
• Confusing GET and POST request handling

4. What is wrong with this API route definition?

Route::get('/data', function () {
    return response('Data');
});

medium

A. It should return JSON, not plain text, for API routes

B. The HTTP verb GET is not allowed in API routes

C. The route path must start with /api/

D. The closure must accept a Request parameter

Solution

1. Step 1: Check the response type for API routes

   API routes should return JSON data, but this returns plain text with response('Data').

2. Step 2: Verify HTTP verb and route path

   GET is allowed, and route paths don't need to start with /api/ because the file already scopes them.

3. Final Answer:

   It should return JSON, not plain text, for API routes -> Option A

4. Quick Check:

   API routes expect JSON responses [OK]

Hint: API routes should return JSON, not plain text [OK]

Common Mistakes:

• Thinking GET is disallowed in API routes
• Believing route paths must start with /api/
• Assuming Request parameter is mandatory

5. You want to create an API route that accepts a user ID in the URL and returns JSON with the user's name. Which of these route definitions correctly achieves this?

hard

A. Route::post('/user', function ($id) { return ['name' => 'User ' . $id]; });

B. Route::get('/user/{id}', function ($id) { return ['name' => 'User ' . $id]; });

C. Route::get('/user', function (Request $request) { return ['name' => 'User ' . $request->id]; });

D. Route::get('/user/{id}', function () { return ['name' => 'User']; });

Solution

1. Step 1: Identify route with URL parameter

   The route must accept a user ID in the URL, so it needs a parameter like {id} in the path.

2. Step 2: Check function parameters and response

   Route::get('/user/{id}', function ($id) { return ['name' => 'User ' . $id]; }); correctly uses $id parameter and returns JSON with the user's name including the ID.

3. Final Answer:

   Route::get('/user/{id}', function ($id) { return ['name' => 'User ' . $id]; }); -> Option B

4. Quick Check:

   URL param {id} passed as $id = Route::get('/user/{id}', function ($id) { return ['name' => 'User ' . $id]; }); [OK]

Hint: Use {id} in route and accept $id in closure [OK]

Common Mistakes:

• Using POST instead of GET for URL params
• Not including {id} in route path
• Not accepting $id parameter in closure