Sorting with sort parameter in Rest API

Introduction

Sorting with a sort parameter helps you get data in the order you want, like from smallest to largest or newest to oldest.

When you want to show a list of products sorted by price from low to high.

When you need to display recent blog posts first by sorting by date.

When you want to organize search results alphabetically by name.

When you want to sort user comments by popularity or newest.

When you want to sort data in an API response to make it easier to read.

Syntax

Rest API

GET /items?sort=field_name
GET /items?sort=-field_name

The sort parameter is added to the URL query string.

Use a minus sign (-) before the field name to sort in descending order.

Examples

Sort products by price in ascending order (lowest to highest).

Rest API

GET /products?sort=price

Sort posts by date in descending order (newest first).

Rest API

GET /posts?sort=-date

Sort users alphabetically by name.

Rest API

GET /users?sort=name

Sample Program

This program calls an API to get items sorted by rating from highest to lowest. It prints each item's name and rating.

Rest API

import requests

# Example API endpoint
url = 'https://api.example.com/items'

# Sort items by 'rating' descending
params = {'sort': '-rating'}

response = requests.get(url, params=params)

if response.status_code == 200:
    items = response.json()
    for item in items:
        print(f"{item['name']}: {item['rating']}")
else:
    print('Failed to get items')

Important Notes

Not all APIs support sorting with a sort parameter; check the API documentation.

Sorting fields must be valid fields in the data, or the API may return an error or ignore the parameter.

Descending order is usually indicated by a minus sign before the field name.

Summary

Use the sort parameter in API requests to control the order of returned data.

Prefix the field with - to sort in descending order.

Sorting makes data easier to understand and use in your app or website.

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