ASP.NET Core Web API Interview Question #85

What are common API versioning strategies?

Routing, Versioning, OpenAPI/Swagger & API Documentation Mid-Level Intermediate

Quick Interview Answer

Common strategies include putting the version in the URL path, query string, custom header, or media type. Each approach has trade-offs involving visibility, caching, client ergonomics, and routing.

Detailed Explanation

Common strategies include putting the version in the URL path, query string, custom header, or media type. Each approach has trade-offs involving visibility, caching, client ergonomics, and routing.

The important requirement is consistency. Choose one strategy appropriate for the API ecosystem and document how versions are selected and retired.

Code Example

// URL:
GET /api/v1/products

// Query:
GET /api/products?api-version=1.0

// Header:
X-Api-Version: 1.0