Media type versioning in Rest API - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to set the media type version in the Accept header.

Rest API

headers = {"Accept": "application/vnd.example.v[1]+json"}

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

A1

Bv1

Cjson

Dversion1

Attempts:

3 left

💡 Hint

Common Mistakes

Including the 'v' in the version number again.

Using 'json' instead of the version number.

The version number in media type versioning is placed as a number after 'v' in the Accept header.

2fill in blank

medium

Complete the code to check if the client requested version 2 in the Accept header.

Rest API

if request.headers.get('Accept') == 'application/vnd.example.v[1]+json':
    process_version_2()

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

A2

B1

Cv2

Djson

Attempts:

3 left

💡 Hint

Common Mistakes

Adding an extra 'v' before the version number.

Using 'json' instead of the version number.

The Accept header should match the exact version number without repeating 'v'.

3fill in blank

hard

Fix the error in the media type versioning string to correctly specify version 3.

Rest API

media_type = "application/vnd.example.[1]+json"

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

Aversion3

Bv3

C3

Dv.3

Attempts:

3 left

💡 Hint

Common Mistakes

Using '3' alone without 'v'.

Adding dots or extra words in the version part.

The correct format includes 'v' followed immediately by the version number, like 'v3'.

4fill in blank

hard

Fill both blanks to create a response with version 1 media type and JSON content.

Rest API

response.headers['Content-Type'] = 'application/vnd.example.[1]+[2]'

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

Av1

Bjson

Cxml

Dv2

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing version and format values.

Using 'xml' instead of 'json' for JSON content.

The Content-Type header must specify the version as 'v1' and the format as 'json'.

5fill in blank

hard

Fill all three blanks to build a media type versioning Accept header for version 4 with XML format.

Rest API

accept_header = 'application/vnd.example.[1]+[2]; charset=[3]'

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

Av4

Bxml

Cutf-8

Djson

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'json' instead of 'xml' for XML format.

Omitting charset or using wrong encoding.

The Accept header includes version 'v4', format 'xml', and charset 'utf-8' for encoding.

Practice

1. What is the main purpose of using media type versioning in REST APIs?

easy

A. To allow clients to specify API versions via custom content types

B. To encrypt API data for security

C. To speed up API response times

D. To change the API URL structure frequently

Solution

1. Step 1: Understand media type versioning concept

   Media type versioning lets clients request specific API versions by setting custom content types in headers.

2. Step 2: Identify the main purpose

   This approach helps keep APIs backward compatible by allowing multiple versions to coexist.

3. Final Answer:

   To allow clients to specify API versions via custom content types -> Option A

4. Quick Check:

   Media type versioning = clients specify versions [OK]

Hint: Remember: version info goes in content type headers [OK]

Common Mistakes:

• Confusing versioning with encryption
• Thinking URL changes are required
• Assuming it improves speed directly

2. Which HTTP header is commonly used by clients to specify the API version in media type versioning?

easy

A. Content-Type

B. Accept

C. Authorization

D. User-Agent

Solution

1. Step 1: Identify header for version negotiation

   The client uses the Accept header to tell the server which media type and version it wants.

2. Step 2: Differentiate from other headers

   Content-Type is for request body format, Authorization is for credentials, and User-Agent identifies the client software.

3. Final Answer:

   Accept -> Option B

4. Quick Check:

   Version in Accept header [OK]

Hint: Accept header tells server what version client wants [OK]

Common Mistakes:

• Using Content-Type instead of Accept for versioning
• Confusing Authorization with version info
• Thinking User-Agent controls version

3. Given this HTTP Accept header:
Accept: application/vnd.example.v2+json
What version of the API is the client requesting?

medium

A. Version 3

B. Version 1

C. Version 2

D. No version specified

Solution

1. Step 1: Parse the media type string

   The media type is application/vnd.example.v2+json. The .v2 part indicates version 2.

2. Step 2: Confirm version number meaning

   The v2 suffix is a common pattern to specify API version 2 in media type versioning.

3. Final Answer:

   Version 2 -> Option C

4. Quick Check:

   v2 in media type means version 2 [OK]

Hint: Look for .vX in media type for version number [OK]

Common Mistakes:

• Ignoring the .v2 and picking version 1
• Confusing +json suffix as version
• Assuming no version if not in URL

4. A client sends this header:
Accept: application/vnd.example.v1+json
But the server responds with version 2 data. What is the likely cause?

medium

A. Accept header syntax is invalid

B. Client sent wrong Content-Type header

C. Server does not support version 2

D. Server ignores Accept header and defaults to latest version

Solution

1. Step 1: Analyze client request and server response

   The client requests version 1 via Accept header, but server returns version 2 data.

2. Step 2: Identify server behavior

   This usually means the server ignores the Accept header and serves the latest version by default.

3. Final Answer:

   Server ignores Accept header and defaults to latest version -> Option D

4. Quick Check:

   Server ignoring Accept header causes version mismatch [OK]

Hint: Mismatch means server likely ignores Accept header [OK]

Common Mistakes:

• Blaming client Content-Type instead of Accept
• Assuming Accept header syntax error without checking
• Thinking server lacks version 2 support

5. You want to support two API versions simultaneously using media type versioning. Which server behavior best supports this?

hard

A. Parse the Accept header and return data matching the requested version

B. Ignore Accept header and always return version 2 data

C. Use URL path versioning instead of media type versioning

D. Return an error if Accept header version is not latest

Solution

1. Step 1: Understand requirement for simultaneous version support

   To support multiple versions, the server must detect which version the client wants.

2. Step 2: Identify correct server behavior

   Parsing the Accept header and returning matching version data allows backward compatibility and coexistence.

3. Final Answer:

   Parse the Accept header and return data matching the requested version -> Option A

4. Quick Check:

   Server parses Accept header to serve requested version [OK]

Hint: Server must read Accept header to serve correct version [OK]

Common Mistakes:

• Ignoring Accept header and forcing one version
• Switching to URL versioning instead of media type
• Returning errors instead of supporting old versions