pj-mill / aspnet_webapi2_versioning

Demonstrates 5 techniques for API versioning using route uri, query string parameters, custom request header & accept header (content-type). Requires Fiddler or POSTMAN to test.

AspNet_WebApi2_Versioning

An ASP.NET Web Api 2 project that demonstrates several techniques for API versioning using route uri, query string parameters, custom request header & accept header (content-type). The project makes use of custom controller selectors that extend/implement both 'DefaultHttpControllerSelector' and 'IHttpControllerSelector', along with custom attribute-based routing & contraints. Requires Fiddler to test.

---

####Technique 01

We want to version our web api by defining URIs like the following:

URI	Mapped To Controller
/api/v1/tasks/	MyProject.Controllers.V1.TasksController
/api/v2/tasks/	MyProject.Controllers.V2.TasksController

#####To Test

In Visual Studio 2015, uncomment the line '// ConfigureNamespaceVersioning(config);' in the WebApiConfig class, then simply run the project using ctrl-F5, and then in Fiddler, issue the following GET requests ...

GET Requests
http://localhost:[YOUR_PORT_NUMBER]/api/v1/tasks
http://localhost:[YOUR_PORT_NUMBER]/api/v2/tasks

Both will respond with a message confirming which controller the request was routed to. (You may need to change the port number from 50333 to whatever is relevant on your system)

---

####Technique 02 We want to version our web api by defining URIs like the following:

URI	Mapped To Controller
/api/v1/tasks/	MyProject.Controllers.TasksController
/api/v2/tasks/	MyProject.Controllers.TasksV2Controller

#####To Test

In Visual Studio 2015, uncomment the line '// ConfigureControllerNameVersioning(config);' in the WebApiConfig class, then simply run the project using ctrl-F5, and then in Fiddler, issue the following GET requests ...

GET Requests
http://localhost:[YOUR_PORT_NUMBER]/api/v1/tasks
http://localhost:[YOUR_PORT_NUMBER]/api/v2/tasks

---

####Technique 03#### We want to version our web api by specifying parameters in our URIs like the following:

URI	Mapped To Controller
/api/tasks/?V1	MyProject.Controllers.TasksController
/api/tasks/?V2	MyProject.Controllers.TasksV2Controller

#####To Test

In Visual Studio 2015, uncomment the line '// ConfigureQueryStringVersioning(config);' in the WebApiConfig class, then simply run the project using ctrl-F5, and then in Fiddler, issue the following GET requests ...

GET Requests
http://localhost:[YOUR_PORT_NUMBER]/api/tasks/?V1
http://localhost:[YOUR_PORT_NUMBER]/api/tasks/?V2

---

####Technique 04 We want to version our web api by specifying parameters in our URIs like the following:

URI	Header Param	Mapped To Controller
/api/tasks/	Version-Num: V1	MyProject.Controllers.TasksController
/api/tasks/	Version-Num: V2	MyProject.Controllers.TasksV2Controller

#####To Test

In Visual Studio 2015, uncomment the line '// ConfigureCustomHeaderVersioning(config);' in the WebApiConfig class, then simply run the project using ctrl-F5, and then in Fiddler, issue the following GET requests ...

GET Requests
http://localhost:[YOUR_PORT_NUMBER]/api/tasks

In the header param sepcify ...

  User-Agent: Fiddler
  Version-Num: V1

OR

  User-Agent: Fiddler
  Version-Num: V2

---

####Technique 05 We want to version our web api by specifying parameters in our URIs like the following:

URI	Content-Type	Mapped To Controller
/api/tasks/	application/json	MyProject.Controllers.TasksController
/api/tasks/	application/xml	MyProject.Controllers.TasksV2Controller

#####To Test

In Visual Studio 2015, uncomment the line '// ConfigureAcceptHeaderVersioning(config);' in the WebApiConfig class, then simply run the project using ctrl-F5, and then in Fiddler, issue the following GET requests ...

GET Requests
http://localhost:[YOUR_PORT_NUMBER]/api/tasks

In the header sepcify ...

  User-Agent: Fiddler
  Content-Type: application/json

OR

  User-Agent: Fiddler
  Content-Type: application/xml

---

####Resources####

Title	Author	Publisher
ASP.NET Web API 2 - Building a REST service from start to finish, Second Edition	Jamie Kurtz and Brian Wortman	APRESS
Building ASP.Net Web API RESTful Service – Part 10	Taiseer Joudeh	Bit Of technology
ASP.NET Web API: Using Namespaces to Version Web APIs	Mike.Wasson	Microsoft
Demystify Web API Versioning	Sachin Kalia	C# Corner