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.

Practice

1. What does the sort parameter do in a REST API request?

easy

A. It filters data based on a condition.

B. It controls the order in which data is returned.

C. It limits the number of results returned.

D. It changes the data format to XML.

Solution

1. Step 1: Understand the purpose of the sort parameter

   The sort parameter is used to arrange the returned data in a specific order.

2. Step 2: Differentiate from other parameters

   Filtering limits data, limiting controls count, and format changes output type, but sorting changes order.

3. Final Answer:

   It controls the order in which data is returned. -> Option B

4. Quick Check:

   Sort parameter = controls order [OK]

Hint: Sort means order, not filter or limit [OK]

Common Mistakes:

• Confusing sort with filter
• Thinking sort limits results
• Assuming sort changes data format

2. Which of the following is the correct way to sort results by the field price in descending order using the sort parameter?

easy

A. sort=desc(price)

B. sort=price-

C. sort=-price

D. sort=price_desc

Solution

1. Step 1: Identify descending order syntax

   In REST APIs, prefixing the field with a minus sign - sorts in descending order.

2. Step 2: Match the correct syntax

   Only sort=-price correctly uses the minus prefix before the field name.

3. Final Answer:

   sort=-price -> Option C

4. Quick Check:

   Minus before field = descending sort [OK]

Hint: Use '-' before field for descending sort [OK]

Common Mistakes:

• Placing '-' after the field name
• Using function-like syntax incorrectly
• Appending '_desc' instead of '-' prefix

3. Given the API request /products?sort=-rating, what will be the order of the returned products?

medium

A. Products sorted by rating from highest to lowest.

B. Products sorted alphabetically by name.

C. Products sorted by rating from lowest to highest.

D. Products sorted by price from lowest to highest.

Solution

1. Step 1: Analyze the sort parameter

   The parameter sort=-rating means sort by the field rating in descending order.

2. Step 2: Determine the order of sorting

   Descending order means highest values first, so products with highest rating come first.

3. Final Answer:

   Products sorted by rating from highest to lowest. -> Option A

4. Quick Check:

   Minus prefix = descending order [OK]

Hint: Minus means descending, so highest values first [OK]

Common Mistakes:

• Assuming minus means ascending
• Confusing rating with price or name
• Ignoring the minus sign

4. You wrote the API request /users?sort=name- to sort users by name descending, but it returns an error. What is the problem?

medium

A. The minus sign should be before the field name, not after.

B. The field name name is invalid for sorting.

C. The sort parameter cannot be used with strings.

D. You need to use order=name_desc instead.

Solution

1. Step 1: Check the position of the minus sign

   The correct syntax places the minus sign before the field name to indicate descending order.

2. Step 2: Identify the error cause

   Using name- places the minus after the field, which is invalid and causes an error.

3. Final Answer:

   The minus sign should be before the field name, not after. -> Option A

4. Quick Check:

   Minus must prefix field for descending [OK]

Hint: Minus after field causes error; put it before [OK]

Common Mistakes:

• Placing minus after field name
• Assuming sort can't be used on strings
• Using wrong parameter like 'order'

5. You want to get a list of blog posts sorted first by date descending, then by title ascending. Which sort parameter should you use?

hard

A. sort=-title,date

B. sort=date,-title

C. sort=title,-date

D. sort=-date,title

Solution

1. Step 1: Understand multi-field sorting syntax

   Multiple fields are separated by commas; order matters for sorting priority.

2. Step 2: Apply descending and ascending correctly

   Use -date for descending date, and title without minus for ascending title.

3. Step 3: Combine fields in correct order

   First sort by date descending, then by title ascending means sort=-date,title.

4. Final Answer:

   sort=-date,title -> Option D

5. Quick Check:

   Minus before date, comma, then title ascending [OK]

Hint: List fields comma-separated; minus means descending [OK]

Common Mistakes:

• Reversing field order
• Putting minus on ascending field
• Using wrong separators like semicolon