Browse by Tags

Tagged Content List
  • Blog Post: 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...
  • Blog Post: 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...
  • Blog Post: 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...
  • Blog Post: 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...
  • Blog Post: 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 http://www.asp.net/vnext . To see this in action, simply create a new ASP.NET Web API...
  • Blog Post: 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...
  • Blog Post: 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 HelpPageAreaRegistration...
  • Blog Post: 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...
  • Blog Post: ASP.NET Web API: Generating a Web API help page using ApiExplorer

    In the previous post , I briefly introduced you to the IApiExplorer which can be used to generate documentation, machine-readable metadata, or a test client. In this blog post, we’re going to take a closer look at the ApiExplorer, which is the default implementation of IApiExplorer, and see how we can...
Page 1 of 1 (9 items)