Recommended practices for Versioning WebAPI interfaces

Question

I'd like to use WebAPI as my API technology to:

Allow approved companies to enter/retrieve data in my systtem
Create a standard interface for my company's iOS/Android/etc. applications

Does anyone know of best practices for, and mechanisms used to implement, versioning of interfaces. Specifically, I don't want to break backwards compatibility if I make updates to my API. I'd like to know what versioning schemes people use and if WebAPI has any built in mechanisms supporting versioning without the need to set up routes/paths every time a new version is released. Any thoughts would be appreciated.

Update After performing some research I think I know what I want to do, I'm not sure how to do it. Ideally during content negotiation I would like to use a media type passed by the user to specify which version of the API should be used (rather than hard-coding the URL) and hit the corresponding controller.

See http://stackoverflow.com/questions/389169/best-practices-for-api-versioning — David Peden, Jun 20 '12 at 05:21
Thanks @DPeden - that link contains some good information. My question was specific to ASP.NET MVC and webapi but I appreciate the info! — JP., Jan 03 '13 at 14:28

score 3 · Answer 1 · answered Jan 03 '13 at 13:17

3

If you don't want the version to be included in the Url, the way to go is probably to implement IHttpControllerSelector. This blog post should give you a good starting point: Implementing API versioning in ASP.NET Web API

answered Jan 03 '13 at 13:17

Christopher

517
1
4
15

score 3 · Answer 2 · answered Jan 03 '13 at 16:31

3

I recommend you take a look at Peter Williams' series of blog posts on versioning REST services. They explain the what and why. For the how, check out Mike Wasson's tutorial on how to create a custom media formatter.

answered Jan 03 '13 at 16:31

David Peden

17,596
6
52
72

Recommended practices for Versioning WebAPI interfaces

2 Answers2