Rest API - API Documentation
You want to document an endpoint that returns a list of products filtered by category and sorted by price. Which structure best captures this in the
parameters section?You want to document an endpoint that returns a list of products filtered by category and sorted by price. Which structure best captures this in the parameters section?
hard📝 Application Q9 of 15
Step-by-Step Solution
Solution:
Step 1: Identify correct parameter types and optionality
Category is a string and optional; sort is a string with limited values and optional.Step 2: Validate the use of enum for sort options
Using enum restricts sort values to "price_asc" or "price_desc", clarifying valid inputs.Final Answer:
[{"name": "category", "type": "string", "required": false}, {"name": "sort", "type": "string", "required": false, "enum": ["price_asc", "price_desc"]}] -> Option DQuick Check:
Parameters with types and enums = correct docs [OK]
Quick Trick: Use enums to restrict parameter values clearly [OK]
Common Mistakes:
MISTAKES- Using wrong types for parameters
- Marking optional parameters as required
- Ignoring filtering and sorting parameters
Master "API Documentation" in Rest API
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Rest API Quizzes