Deprecation communication in Rest API - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ Predict Output

intermediate

What is the HTTP status code returned for a deprecated API endpoint?

Consider a REST API that marks an endpoint as deprecated but still functional. What HTTP status code should the server ideally return to inform clients about deprecation without breaking functionality?

A 200 OK with a custom warning header indicating deprecation

B 404 Not Found because the endpoint is deprecated

C 410 Gone to indicate the endpoint is permanently removed

D 500 Internal Server Error due to deprecated code

💡 Hint

Think about how to keep the endpoint working but still warn clients.

The best practice is to return 200 OK so the endpoint still works, but include a custom header like Warning to inform clients about deprecation. Returning 404 or 410 would break clients immediately, and 500 is for server errors.

🧠 Conceptual

intermediate

Why use a 'Deprecation' header in REST APIs?

What is the main purpose of including a 'Deprecation' HTTP header in REST API responses?

A To block clients from accessing the deprecated endpoint

B To inform clients that the API endpoint will be removed in the future

C To provide authentication credentials

D To indicate the API response format

💡 Hint

Think about communication with clients regarding future changes.

The 'Deprecation' header is used to notify clients that the endpoint is planned to be removed later, giving them time to migrate. It does not block access or relate to authentication or response format.

🔧 Debug

advanced

Identify the issue in this deprecation warning implementation

This API code snippet tries to add a deprecation warning header but clients do not see it. What is the problem?

Rest API

def get_user(request):
    response = get_user_data()
    response.headers['Deprecation'] = 'true'
    return response

A The response object does not support headers

B Headers must be added before the response object is created

C The header name should be lowercase 'deprecation'

D The 'Deprecation' header value should be a date or URL, not 'true'

💡 Hint

Check the expected format of the 'Deprecation' header value.

The 'Deprecation' header expects a date or a URL indicating when the API will be removed or more info. Using 'true' is not a valid value, so clients may ignore it.

📝 Syntax

advanced

Which code snippet correctly adds a deprecation warning header in Express.js?

You want to add a 'Warning' header to indicate API deprecation in an Express.js route. Which snippet is correct?

A res.addHeader('Warning', '299 - Deprecated API'); res.send(data);

B res.set('Warning', 299 - 'Deprecated API'); res.send(data);

C res.setHeader('Warning', '299 - "Deprecated API"'); res.send(data);

D res.header('Warning', 299 - 'Deprecated API'); res.send(data);

💡 Hint

Check the correct method name and header value format.

The correct method is setHeader and the header value must be a string. Option C uses the correct syntax and quotes.

🚀 Application

expert

How to communicate API version deprecation effectively?

You maintain a REST API with version v1 and v2. You want to deprecate v1 but keep it working for 6 months. Which approach best communicates this to clients?

A Return 200 OK with 'Deprecation' and 'Sunset' headers indicating removal date, and document in API docs

B Return 404 Not Found for all v1 requests immediately

C Return 500 Internal Server Error with a message about deprecation

D Remove v1 endpoints without notice and update docs silently

💡 Hint

Think about gradual migration and clear communication.

Using Deprecation and Sunset headers along with documentation gives clients time to migrate while keeping the API functional. Abrupt removal or errors cause client failures.