[Solved] You want to document an API that returns a list of products with optional filtering... Which OpenAPI feature helps you define the optional category filter parameter for the GET /products endpoint? | Rest API

Rest API - API Documentation

You want to document an API that returns a list of products with optional filtering by category. Which OpenAPI feature helps you define the optional category filter parameter for the GET /products endpoint?

AUse a query parameter with <code>required: false</code> under the GET method

BAdd a path parameter named <code>category</code> in the URL

CInclude <code>category</code> in the requestBody schema

DDefine <code>category</code> as a header parameter

Step-by-Step Solution

Solution:

Step 1: Understand parameter types
Optional filters are usually query parameters, not path or header parameters.
Step 2: Define optional query parameter
Set required: false for the category query parameter under GET.
Final Answer:
Use a query parameter with required: false under the GET method -> Option A
Quick Check:
Optional filters = query params with required false [OK]

Quick Trick: Filters usually go as optional query parameters [OK]

Common Mistakes:

MISTAKES

Using path parameters for optional filters
Putting filters in requestBody for GET
Defining filters as headers

Master "API Documentation" in Rest API

9 interactive learning modes - each teaches the same concept differently

Learn Why Deep Visual Try Challenge Project Recall Time

More Rest API Quizzes

Which OpenAPI feature helps you define the optional category filter parameter for the GET /products endpoint?

Step 1: Understand parameter types

Step 2: Define optional query parameter

Final Answer:

Quick Check:

Want More Practice?