RicoSuter/NSwag

Support versioning with headers

Open

#1,284 opened on Apr 19, 2018

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)C# (1,357 forks)batch import
help wantedtype: enhancement

Repository metrics

Stars
 (7,359 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Right now versioning only works with url path segments. Headers should also be supported. Here is an explanation on how to do headers versioning.

Contributor guide

Research direction
Study the referenced article about header based versioning in ASP.NET Core. Examine NSwag current URL path versioning implementation and determine how to extend it to accept version from request headers. Look at the existing versioning middleware and API versioning options.
Tech stack
csharp
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75