API versioning strategies in HLD - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is API versioning and why is it important?

API versioning is the practice of managing changes in an API by creating different versions. It is important to ensure backward compatibility and allow clients to continue using older versions without breaking when new features or fixes are added.

beginner

Name four common API versioning strategies.

Common API versioning strategies include: 1) URI versioning (version in URL path), 2) Query parameter versioning, 3) Header versioning (custom headers), 4) Content negotiation (Accept header).

beginner

What is URI versioning in APIs?

URI versioning means including the version number directly in the API URL path, for example, /api/v1/resource. It is simple and easy to cache but can lead to duplicated endpoints.

intermediate

Explain header versioning and one advantage it has.

Header versioning uses custom HTTP headers to specify the API version, such as 'X-API-Version: 1'. An advantage is that it keeps URLs clean and separates versioning from resource paths.

intermediate

What is content negotiation in API versioning?

Content negotiation uses the HTTP Accept header to specify the version, for example, 'Accept: application/vnd.example.v1+json'. It allows flexible versioning and supports multiple formats but can be complex to implement.

Which API versioning strategy includes the version number in the URL path?

A URI versioning

B Header versioning

C Query parameter versioning

D Content negotiation

URI versioning places the version directly in the URL path, such as /api/v1/resource.

What is a key benefit of using header versioning?

A Easy to bookmark URLs

B Simplifies caching

C Keeps URLs clean

D Automatically supported by browsers

Header versioning keeps URLs clean by moving version info to HTTP headers.

Which versioning method uses the Accept HTTP header?

A Content negotiation

B URI versioning

C Query parameter versioning

D Header versioning

Content negotiation uses the Accept header to specify API version and format.

What is a disadvantage of URI versioning?

A Hard to cache

B Leads to duplicated endpoints

C Requires custom headers

D Not supported by HTTP

URI versioning can lead to duplicated endpoints for each version.

Which versioning strategy can be added without changing the URL?

A URI versioning

B Path suffix versioning

C Query parameter versioning

D Header versioning

Header versioning adds version info in HTTP headers, leaving URLs unchanged.

Describe the main API versioning strategies and their pros and cons.

Think about how version info is passed and how it affects URLs and clients.

Explain why API versioning is necessary and how it helps maintain backward compatibility.

Consider what happens when APIs change and clients still use old versions.