Design-time generation of help page (or client) for ASP.NET Web API

All the help page samples I’ve shown you so far are pretty much generated at runtime, meaning the help page is generated after you start the application. Today, I’m going to show you that it doesn’t always need to be generated at runtime. In fact, it can be generated at design-time. Yes, before you host…


Making ASP.NET Web API Help Page work on self-hosted services

Even though ASP.NET Web API Help Page is implemented using ASP.NET MVC, which won’t work on self-hosted services, most of the code in the package however can be reused to support the generation of Help Page on self host. I’ve created a sample to illustrate how this can be done. The code can be downloaded…


ASP.NET Web API Help Page is now part of the Web API project template

I’m pleased to announce that with the ASP.NET Fall 2012 Update (preview), ASP.NET Web API Help Page is now included by default in the Web API project template. Check it out by downloading the installer available at To see this in action, simply create a new ASP.NET Web API project after installing the update….

ASP.NET Web API Help Page Part 2: Providing custom samples on the Help Page

Samples in ASP.NET Web API Help Page are automatically generated based on your action parameters and return types. They represent the kind of contents that could go into the request or response body. For instance, if you have the Delete action inside ValuesController like below:  public class ValuesController : ApiController { public void Delete(CompositeValue param);…


Introducing the ASP.NET Web API Help Page (Preview)

Today, following the announcement of the official release for ASP.NET Web API , we also released a preview for the ASP.NET Web API Help Page, which is available as a NuGet package. This package automatically generates help page content for Web APIs on your site. Visitors to your help page can use this content to…