注：本文是【ASP.NET Web API系列教程】的一部分，如果您是第一次看本博客文章，请先看前面的内容。
2.4 Creating a Help Page for a Web API2.4 创建Web API帮助页面
本文引自：
By Mike Wasson | August 3, 2012
作者：Mike Wasson ｜ 日期：2012-8-3
This tutorial shows how to create a help page for a web API, by using the ApiExplorer class.
本教程展示如何运用ApiExplorer类为Web API创建帮助页面。
The ApiExplorer class provides descriptive information about the APIs exposed by a web API. ApiExplorer provides the raw material that you can use to create a help page. The ApiExplorer contains an ApiDescription collection, one for each API that it discovers in your project. For this purpose, an "API" is defined as the combination of HTTP method and relative URI. For example, here are some distinct APIs:
ApiExplorer类对Web API所暴露的每个API提供了描述信息。（因此，）ApiExplorer提供了可以用来创建帮助页面的原始材料。ApiExplorer含有一个ApiDescription集合，一个在你项目中发现的每个API的集合。为此，所谓一个“API”的定义是一个HTTP方法与相关URI的结合。例如，以下是一些不同的API：
GET /api/Products（HTTP方法是GET，URI是/api/Products，两者的结合便是一个API。下同 — 译者注）
GET /api/Products/{id}
POST /api/Products
If a single controller action supports multiple HTTP methods, the ApiExplorer treats each as a distinct API.
如果一个单一的控制器动作支持多个HTTP方法，ApiExplorer会把每一个都作为不同的API看待。
For this tutorial, we will create the help page as an MVC view, using Razor syntax to render the HTML. First, create a new project using the "Web API" project template.
对于本教程，我们将把帮助页面创建成一个MVC视图，用Razor语法来渲染HTML。首先用“Web API”项目模板创建一个新项目（如图2-27）。
图2-27. 创建项目
This template creates a project that contains a Web API controller (ValuesController.cs) and an MVC controller (HomeController.cs).
这个模板会创建含有一个Web API控制器（ValuesController.cs）和一个MVC控制器（HomeController.cs）的项目。
Add a model class:
添加一个模型类：
namespace HelpDemo.Models { public class Product { public string Name { get; set; } public decimal Price { get; set; } } }
Add another Web API controller:
添加另一个Web API控制器：
namespace HelpDemo.Controllers { using System.Collections.Generic; using System.Net; using System.Net.Http; using System.Web.Http; using HelpDemo.Models; public class ProductsController : ApiController { public IEnumerable<Product> Get() { return new Product[0]; } public HttpResponseMessage Get(int id) { return Request.CreateResponse(HttpStatusCode.NotFound); } public void Post(Product value) { } public void Put(int id, Product value) { } } }
This controller is not really functional, and you don‘t have to use this exact code. This purpose of this controller is just to give the ApiExplorer something to consume.
这个控制器并不是真正功能性的，而且你不必精确使用这些代码。这个控制器的目的只是为ApiExplorer提供一些可供使用的东西。（这里意在说明，在一个实际应用程序中，可能需要一个类似于这样的控制器，但其内容（代码）需酌情而定 — 译者注）
Next, we‘ll create a view model that gets data from the ApiExplorer. We could pass the ApiExplorer object directly to the MVC view. However, encapsulating the ApiExplorer in a model gives us more flexibility to manipulate the data.
下一步，，我们将创建一个从ApiExplorer获取数据的视图模型，然后可以把ApiExplorer对象直接传递给MVC视图。然而，把ApiExplorer封装在一个模型中，可以让我们能够更灵活性地维护数据。
namespace HelpDemo.Models { using System; using System.Collections.Generic; using System.Linq; using System.Web.Http.Controllers; using System.Web.Http.Description; public class ApiModel { IApiExplorer _explorer; public ApiModel(IApiExplorer explorer) { if (explorer == null) { throw new ArgumentNullException("explorer"); } _explorer = explorer; } public ILookup<string, ApiDescription> GetApis() { return _explorer.ApiDescriptions.ToLookup( api => api.ActionDescriptor.ControllerDescriptor.ControllerName); } } }
The GetApis method converts the collection into an ILookup, grouped by controller name. That makes it easy to group the help page by controller.
GetApis方法将集合转换成一个按控制器名称进行分组的ILookup。这样便于按控制器对帮助页面进行分组。