Saturday, December 6, 2014

Add a Help Page to your existing ASP.NET Web API Project

If you are using Visual Studio 2013 and you create a brand new ASP.NET Web API project, chances are you will already get the necessary structure to be able to use a Help Page for clearly viewing all of the available ASP.NET Web API routes in your project.

However, what if you have an older ASP.NET Web API project that does not have this feature?

Well, fortunately, this is available through a NuGet package called Microsoft.AspNet.WebAPI.HelpPage

You can read more about this NuGet package here:

The nice thing about this package is that it displays ALL of your routes including your Custom routes that you have defined by decorating your Web API Controllers with attributes!   This makes it very handy to easily discover and document the available RESTful services available in your ASP.NET Web API project. 

No comments:

Post a Comment