dotnet-api-versioning

Configure URL segment, header, and query string versioning for ASP.NET Core services.

Updated Aug 16, 2025
One-click install
npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-api-versioning-dodyg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-api-versioning
Source: https://github.com/dodyg/blue-nile-pds/tree/main/.agents/skills/dotnet-api-versioning
Command: npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-api-versioning-dodyg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API versioning is standardized across ASP.NET Core services using Asp.Versioning, enabling consistent, discoverable, and maintainable versioning strategies.

Core Features & Use Cases

  • URL segment versioning: embed the API version in the URL for simple, visible routing.
  • Header and Query string readers: support alternative versioning strategies to match client constraints.
  • Sunset policies & migration: manage deprecation with migration guidance and RFC 8594 alignment.

Quick Start

Install Asp.Versioning packages, register versioning in your DI container, and enable URL segment versioning for your API.

Frequently Asked Questions about dotnet-api-versioning

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I version ASP.NET Core APIs using URL segments, headers, and query strings?

You can version ASP.NET Core APIs by installing Asp.Versioning packages and configuring ApiVersioning in your DI container to enable URL segment, header, and query string version readers for Minimal APIs and MVC controllers.

What is the best way to implement sunset policies and deprecation for ASP.NET Core API versions?

The best way to implement sunset policies for ASP.NET Core API versions is using Asp.Versioning to manage deprecation with migration guidance and RFC 8594 alignment, ensuring clients receive proper transition instructions.

Does ASP.NET Core API versioning work with both Minimal APIs and MVC controllers?

Yes, ASP.NET Core API versioning works with both Minimal APIs and MVC controllers by registering versioned routes and enabling version readers through the Asp.Versioning packages in your DI container.

Do I need .NET 8 to use Asp.Versioning for API versioning in ASP.NET Core?

Yes, you need .NET 8 or higher to use Asp.Versioning for API versioning in ASP.NET Core, as this is a stated prerequisite for applying URL, header, and query string versioning strategies.

When should I use header versioning versus query string versioning for ASP.NET Core APIs?

Use header versioning versus query string versioning for ASP.NET Core APIs based on client constraints: header versioning keeps URLs clean while query string versioning provides simple, visible routing for easier testing.