Versioning best practices in Rest API - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to specify the API version in the URL path.

Rest API

GET /api/[1]/users

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

Av1

Bversion1

Capi1

Dusers

Attempts:

3 left

💡 Hint

Common Mistakes

Using descriptive words like 'version1' instead of 'v1'.

Putting 'users' as the version segment.

Using v1 in the URL path is a common way to specify API version.

2fill in blank

medium

Complete the header to specify the API version using a custom header.

Rest API

X-API-[1]: 1

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

Av

Bver

Capi

Dversion

Attempts:

3 left

💡 Hint

Common Mistakes

Using too short or unclear header names like 'ver' or 'v'.

Using 'api' which is too generic.

The custom header X-API-version is commonly used to specify API version.

3fill in blank

hard

Fix the error in the versioning strategy by choosing the correct versioning method.

Rest API

Accept: application/json; version=[1]

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

Aversion1

Bv1

C1.0

Dapi1

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'v1' or 'version1' which are not standard in Accept header.

Using 'api1' which is unclear.

Using a numeric version like '1.0' in the Accept header is a standard practice.

4fill in blank

hard

Fill both blanks to create a versioned API endpoint with query parameter versioning.

Rest API

GET /api/users?[1]=[2]

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

Aversion

Bv

C1

Dv1

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'v' as parameter name which is less clear.

Using 'v1' as version value which mixes prefix and number.

Using version=1 as a query parameter is a clear way to specify API version.

5fill in blank

hard

Fill all three blanks to define a versioned API using media type versioning in the Accept header.

Rest API

Accept: application/vnd.myapp.[1]+json; version=[2]; q=[3]

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

Avnd

B1

C0.9

Dv1

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'vnd' as version in media type which is part of the type prefix.

Using 'v1' as quality factor which should be a decimal.

The media type uses 'v1' as version in the type, '1' as version parameter, and '0.9' as quality factor.

Practice

1. What is the main reason to use versioning in a REST API?

easy

A. To hide the API from users

B. To make the API faster

C. To reduce the number of API endpoints

D. To keep the API stable and avoid breaking existing clients

Solution

1. Step 1: Understand API stability

   Versioning helps keep the API stable by allowing changes without breaking existing users.

2. Step 2: Identify the main goal of versioning

   The main goal is to avoid breaking existing clients when the API changes.

3. Final Answer:

   To keep the API stable and avoid breaking existing clients -> Option D

4. Quick Check:

   Versioning = Stability [OK]

Hint: Versioning protects old users from breaking changes [OK]

Common Mistakes:

• Thinking versioning makes API faster
• Believing versioning reduces endpoints
• Assuming versioning hides the API

2. Which of the following is a correct way to include versioning in a REST API URL?

easy

A. /api/v1/users

B. /api/users/v1

C. /v1/api/users

D. /users/api/v1

Solution

1. Step 1: Identify common versioning URL pattern

   The standard practice is to put the version right after the base API path, like /api/v1/.

2. Step 2: Check each option

   Only /api/v1/users follows the common pattern where version is after /api/.

3. Final Answer:

   /api/v1/users -> Option A

4. Quick Check:

   Version in URL path = /api/v1/ [OK]

Hint: Version usually goes right after /api/ in URL [OK]

Common Mistakes:

• Placing version after resource name
• Putting version before /api/
• Adding version at the end of URL

3. Given this API request header: Accept: application/vnd.example.v2+json, what version of the API is being requested?

medium

A. Version 3

B. Version 1

C. Version 2

D. No version specified

Solution

1. Step 1: Analyze the Accept header format

   The header uses media type versioning with 'v2' indicating version 2.

2. Step 2: Identify the version number

   The 'v2' in 'application/vnd.example.v2+json' means version 2 is requested.

3. Final Answer:

   Version 2 -> Option C

4. Quick Check:

   Header v2 means API version 2 [OK]

Hint: Look for 'v' followed by number in Accept header [OK]

Common Mistakes:

• Ignoring 'v2' and assuming version 1
• Confusing media type with version
• Assuming no version if not in URL

4. You have an API that uses URL versioning like /api/v1/resource. You want to upgrade to version 2 but keep version 1 working. What is the best fix if your current code overwrites the version path and breaks v1?

medium

A. Create separate routes for /api/v1/resource and /api/v2/resource

B. Remove version from URL and use query parameters instead

C. Only keep /api/v2/resource and delete /api/v1/resource

D. Use the same code for both versions without changes

Solution

1. Step 1: Understand versioning goal

   Versioning allows multiple versions to coexist so old clients keep working.

2. Step 2: Fix route handling

   Separate routes for each version keep both versions working without conflict.

3. Final Answer:

   Create separate routes for /api/v1/resource and /api/v2/resource -> Option A

4. Quick Check:

   Separate routes = keep versions working [OK]

Hint: Keep old and new versions on separate routes [OK]

Common Mistakes:

• Overwriting old version routes
• Removing version info completely
• Using same code for different versions

5. You want to design an API versioning strategy that allows clients to specify the version either in the URL path or in a custom header. Which approach best follows versioning best practices?

hard

A. Ignore versioning and always use the latest API version

B. Support both methods but clearly document and prefer one as primary

C. Allow clients to mix URL and header versions freely without restrictions

D. Use query parameters for versioning only

Solution

1. Step 1: Understand consistency in versioning

   Best practice is to be consistent and clear about versioning methods.

2. Step 2: Choose a primary versioning method

   Supporting both but preferring one and documenting it helps developers avoid confusion.

3. Final Answer:

   Support both methods but clearly document and prefer one as primary -> Option B

4. Quick Check:

   Clear, consistent versioning = best practice [OK]

Hint: Pick one versioning method as main, document it well [OK]

Common Mistakes:

• Mixing versions without clear rules
• Ignoring versioning and breaking clients
• Using only query parameters without reason