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 Part 3: Advanced Help Page customizations

In this post, I’ll go over some advanced customization scenarios for ASP.NET Web API Help Page. First, I’ll demonstrate how you can enable new functionalities such as displaying the documentation in the <returns> tag by adding a new property to the HelpPageApiModel. Second, I’ll show you how to create a custom display template for samples…


Adding a simple Test Client to ASP.NET Web API Help Page

ASP.NET Web API Help Page is a useful extension that automatically generates a web-based documentation for you Web APIs. It makes debugging easier because you can copy/paste the information from Help Page to tools like Fiddler, to call your Web API service and examine the response. Now, wouldn’t it be cool if you can do…


Deploying your first Facebook App on Azure using ASP.NET MVC Facebook Template

Today we announced the preview for ASP.NET Fall 2012 Update and one of the cool features we added to the update is the Facebook Application Template. This template includes a new library that makes it easier to develop Facebook applications using ASP.NET MVC. Here is the tutorial to learn more about this template. In this…


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);…


ASP.NET Web API Help Page Part 1: Basic Help Page customizations

Now that you have installed the ASP.NET Web API Help Page, I’m going to walk you through some of the basic customizations that you can do to make the help page more personalized. Changing the help page URI By default, the help page is available at /help. However you can easily change that in the…


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…


ASP.NET Web API and Azure Blob Storage

When you create a Web API service that needs to store large amount of unstructured data (pictures, videos, documents, etc.), one of the options you can consider is to use Windows Azure Blob Storage. It provides a fairly straightforward way of storing unstructured data in the cloud. In this post, I’ll show you how to…