Rest API - API Documentation
You want to show an example response for a REST API endpoint that returns a list of users with their IDs and names. Which JSON structure is best?
You want to show an example response for a REST API endpoint that returns a list of users with their IDs and names. Which JSON structure is best?
hard📝 Application Q8 of 15
Step-by-Step Solution
Solution:
Step 1: Understand common JSON response patterns for lists
Wrapping the list in a key like "users" is clear and common.Step 2: Compare options for clarity and structure
{ "users": [ { "id": 1, "name": "Anna" }, { "id": 2, "name": "Ben" } ] } uses an array of objects with id and name inside "users" key, which is best practice.Final Answer:
{ "users": [ { "id": 1, "name": "Anna" }, { "id": 2, "name": "Ben" } ] } -> Option CQuick Check:
List of users = array inside "users" key [OK]
Quick Trick: Wrap lists in a named key for clarity [OK]
Common Mistakes:
MISTAKES- Returning raw arrays without a key
- Using object with IDs as keys instead of array
- Mixing object and array structures incorrectly
Master "API Documentation" in Rest API
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Rest API Quizzes