Why documentation drives adoption in Rest API - Test Your Understanding

Practice - 5 Tasks

1fill in blank

easy

Complete the code to set the API base URL.

Rest API

api_base_url = "[1]"

Drag options to blanks, or click blank then click option'

Ahttps://api.example.com

Bapi.example.com

Chttp//api.example.com

Dexample.com/api

Attempts:

3 left

💡 Hint

Common Mistakes

Omitting the protocol (https://) causes connection errors.

The API base URL must include the protocol (https://) to be valid and accessible.

2fill in blank

medium

Complete the code to add a header for JSON content type.

Rest API

headers = {"Content-Type": "[1]"}

Drag options to blanks, or click blank then click option'

Atext/plain

Btext/html

Capplication/xml

Dapplication/json

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'text/html' or 'application/xml' instead of 'application/json'.

APIs commonly use 'application/json' as the content type for sending and receiving JSON data.

3fill in blank

hard

Fix the error in the code to correctly send a GET request using the requests library.

Rest API

response = requests.[1](api_base_url, headers=headers)

Drag options to blanks, or click blank then click option'

Aget

Bput

Cpost

Ddelete

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'post' or 'put' instead of 'get' for fetching data.

To retrieve data from an API, the GET method is used. Using POST or others would change the request type.

4fill in blank

hard

Complete the code to parse JSON response and extract the 'data' field.

Rest API

json_response = response.[1]()
data = json_response"data"

Drag options to blanks, or click blank then click option'

Ajson

Bget

C[

D.

Attempts:

3 left

💡 Hint

Common Mistakes

Using dot notation instead of brackets to access dictionary keys.

Use the json() method to parse the response, then access the 'data' field using square brackets.

5fill in blank

hard

Fill both blanks to create a dictionary comprehension filtering items with value > 10.

Rest API

filtered = {k: v for k, v in data.items() if v [1] 10 and [2](k, str)}

Drag options to blanks, or click blank then click option'

A:

B>

Cisinstance

D==

Attempts:

3 left

💡 Hint

Common Mistakes

Using '=' instead of ':' in dictionary comprehension.

Using '==' instead of '>' for comparison.

Using dot notation instead of isinstance for type checking.

Dictionary comprehension uses ':' to separate keys and values. The condition checks if value is greater than 10 and key is a string using isinstance.

Practice

1. Why is good documentation important for a REST API?

easy

A. It helps users understand how to use the API correctly.

B. It makes the API run faster.

C. It hides the API's internal code.

D. It reduces the number of API endpoints.

Solution

1. Step 1: Understand the role of documentation

   Documentation explains how to use the API, making it easier for users to understand its functions.

2. Step 2: Identify the correct benefit

   Helping users understand usage is the main purpose, not performance or hiding code.

3. Final Answer:

   It helps users understand how to use the API correctly. -> Option A

4. Quick Check:

   Documentation improves understanding = D [OK]

Hint: Documentation explains usage clearly to users [OK]

Common Mistakes:

• Confusing documentation with performance optimization
• Thinking documentation hides code
• Believing documentation reduces API endpoints

2. Which of the following is the correct way to include an example in REST API documentation?

easy

A. Write the API code without any comments.

B. Only list the API endpoint URL without details.

C. Show a sample request and response with clear explanations.

D. Use complex technical terms without examples.

Solution

1. Step 1: Identify what makes examples helpful

   Examples should show how to call the API and what response to expect, with clear explanations.

2. Step 2: Compare options

   Options B, C, and D lack clarity or helpful examples, making them poor documentation choices.

3. Final Answer:

   Show a sample request and response with clear explanations. -> Option C

4. Quick Check:

   Examples with requests and responses = A [OK]

Hint: Examples must show request and response clearly [OK]

Common Mistakes:

• Skipping examples in documentation
• Using only URLs without context
• Writing code without explanation

3. Given this API documentation snippet:

{
  "endpoint": "/users",
  "method": "GET",
  "description": "Returns a list of users",
  "example_response": [{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]
}

What will a user expect when calling this API?

medium

A. A list of user objects with id and name fields.

B. An error message because the method is wrong.

C. A single user object with detailed info.

D. No response because the endpoint is missing.

Solution

1. Step 1: Analyze the documentation snippet

   The endpoint "/users" with method GET returns a list of users as shown in example_response.

2. Step 2: Understand the expected output

   The example_response shows an array of user objects with id and name, so the user expects this list.

3. Final Answer:

   A list of user objects with id and name fields. -> Option A

4. Quick Check:

   GET /users returns list of users = A [OK]

Hint: Match example response to expected output [OK]

Common Mistakes:

• Confusing list with single object
• Assuming error without reason
• Ignoring example response

4. You find this documentation snippet:

Endpoint: /items
Method: POST
Description: Adds a new item
Example request: {"name": "Book"}

But users report errors when calling the API. What is likely missing?

medium

A. The API endpoint URL.

B. The API server IP address.

C. The HTTP method used.

D. The example response showing success or error messages.

Solution

1. Step 1: Review the provided documentation

   The snippet shows endpoint, method, description, and example request but no example response.

2. Step 2: Identify what users need to avoid errors

   Without example response, users don't know what to expect or how to handle errors properly.

3. Final Answer:

   The example response showing success or error messages. -> Option D

4. Quick Check:

   Missing example response causes confusion = B [OK]

Hint: Always include example responses in docs [OK]

Common Mistakes:

• Ignoring example responses
• Assuming endpoint or method is missing
• Thinking server IP is needed in docs

5. You want to improve adoption of your REST API. Which combination of documentation features will most likely help?

hard

A. Using technical jargon and skipping examples to save time.

B. Clear endpoint descriptions, example requests and responses, and error explanations.

C. Only listing endpoints without details to keep docs short.

D. Providing code snippets without explaining parameters.

Solution

1. Step 1: Identify key documentation features that aid adoption

   Clear descriptions, examples, and error info help users understand and trust the API.

2. Step 2: Evaluate other options

   Options A, B, and D omit important details or clarity, which reduces adoption.

3. Final Answer:

   Clear endpoint descriptions, example requests and responses, and error explanations. -> Option B

4. Quick Check:

   Complete, clear docs increase adoption = C [OK]

Hint: Combine clarity, examples, and error info in docs [OK]

Common Mistakes:

• Thinking shorter docs are better
• Using jargon without explanation
• Skipping error handling info