Sorting with sort parameter in Rest API - Step-by-Step Execution

Concept Flow - Sorting with sort parameter

Receive API Request

↓

Check for 'sort' parameter

↓

Parse sort

↓

Return data

↓

Return sorted data

The API receives a request, checks if a 'sort' parameter is present, then sorts the data accordingly before returning it.

Execution Sample

Rest API

GET /items?sort=price

Response: Sorted list by price ascending

This API call requests items sorted by their price in ascending order.

Execution Table

Step	Action	Sort Parameter Present?	Sort Parameter Value	Data Before Sort	Data After Sort	Response
1	Receive API request	Yes	price	[{"name": "A", "price": 30}, {"name": "B", "price": 10}, {"name": "C", "price": 20}]	[{"name": "B", "price": 10}, {"name": "C", "price": 20}, {"name": "A", "price": 30}]	Return sorted data by price ascending
2	Return response	Yes	price	[{"name": "B", "price": 10}, {"name": "C", "price": 20}, {"name": "A", "price": 30}]	[{"name": "B", "price": 10}, {"name": "C", "price": 20}, {"name": "A", "price": 30}]	Response sent with sorted data

💡 Sorting complete and response returned to client

Variable Tracker

Variable	Start	After Step 1	After Step 2
sort_parameter	null	price	price
data	[{"name": "A", "price": 30}, {"name": "B", "price": 10}, {"name": "C", "price": 20}]	[{"name": "B", "price": 10}, {"name": "C", "price": 20}, {"name": "A", "price": 30}]	[{"name": "B", "price": 10}, {"name": "C", "price": 20}, {"name": "A", "price": 30}]

Key Moments - 2 Insights

What happens if the 'sort' parameter is missing in the request?

If the 'sort' parameter is missing, the API returns the data unsorted, as shown by the 'No' branch in the concept flow and the absence of sorting in the execution table.

How does the API know which field to sort by?

The API reads the value of the 'sort' parameter (e.g., 'price') and uses it to sort the data, as seen in the execution table where 'sort_parameter' changes to 'price' and data is sorted accordingly.

Visual Quiz - 3 Questions

Look at the execution table, what is the value of 'sort_parameter' after step 1?

A price

B null

C name

D unsorted

💡 Hint

Check the 'sort_parameter' column in the variable_tracker after step 1.

At which step is the data sorted?

A Step 2

B Before Step 1

C Step 1

D Data is never sorted

💡 Hint

Look at the 'Data After Sort' column in the execution_table for each step.

If the 'sort' parameter was missing, what would the response contain?

A An error message

B Unsorted data

C Sorted data by default

D Empty data

💡 Hint

Refer to the concept_flow where the 'No' branch returns unsorted data.

Concept Snapshot

Sorting with sort parameter in REST API:
- Client sends request with ?sort=field
- Server checks for 'sort' parameter
- If present, server sorts data by that field
- Returns sorted data
- If missing, returns unsorted data

Full Transcript

This visual execution shows how a REST API handles sorting using a 'sort' parameter. When the API receives a request, it checks if the 'sort' parameter is present. If yes, it reads the parameter value (like 'price') and sorts the data accordingly. The sorted data is then returned in the response. If the parameter is missing, the API returns the data as is, without sorting. The execution table traces each step, showing the state of variables and data before and after sorting. Key moments clarify common confusions about missing parameters and sorting logic. The quiz tests understanding of variable values and flow steps.