【首发】ASP.NET Web API教程（二）

　　六、接口描述文档

　　ASP.NET Web API虽然是服务端的接口，但当它发布到IIS之后，运行时，由于缺少默认页面，浏览器将看不到正常的页面显示。同时，对于客户端开发者来说，如果看不到web api的源码，也没有其他文档描述接口，就不知道有哪些接口可以调用，各自的参数是怎么样的。为此，web api专门提供了HelpPage来根据接口上面的注释生成接口描述文档，而且使用起来也很简单，主要用【NuGet】安装【Microsoft.AspNet.WebApi.HelpPage】即可。

　　七、自托管ASP.NET Web API

　　ASP.NET Web API不需要IIS，可以在自己的主机进程中自托管。下面将介绍如何在控制台应用程序中托管Web API。

　　1.创建控制台应用程序项目

　　启动Visual Studio，然后从“开始”页中选择新建项目。或者，从“文件”菜单中选择“新建”，然后选择“项目”。在模板窗格中，选择已安装的模板，然后展开Visual C#节点。在Visual C#下，选择Windows。在项目模板列表中，选择“控制台应用程序”。将项目命名为SelfHost，然后单击确定。

　　2.设置目标框架

　　如果使用Visual Studio2010，请将目标框架更改为.NET Framework4.0。在解决方案资源管理器中，右键单击项目并选择属性。在目标框架下拉列表中，将目标框架更改为.NET Framework4.0。当系统提示应用更改时，单击是。

　　3.安装NuGet包管理器

　　NuGet包管理器是将Web API程序集添加到non-ASP.NET项目的最简单方法。安装NuGet包管理器的方法如下：

　　启动Visual Studio，然后在工具菜单上，选择扩展和更新。在扩展和汇报对话框中，选择联机。如果未看到NuGet包管理器，请在搜索框中键入nuget包管理器。选择NuGet包管理器，然后单击下载。下载完成后，系统会提示安装。

　　八、Hosting ASP.NET Web API

　　1.安装Microsoft.AspNet.WebApi.HelpPage

　　在项目中添加描述文档的方法如下：

　　在项目上点击右键 ->【管理NuGet程序包】

　　在NuGet界面，点击【浏览】->输入【help】，待搜索完成后，选择【Microsoft.AspNet.WebApi.HelpPage】，在右侧点击【安装】。之后弹出的各种确认框，都点击确定即可。

　　2.配置HelpPage

　　安装完成后，会在项目中增加Areas文件夹，并包含很多文件与代码。在Global.asax文件的ApplicationStart方法中增加AreaRegistration.RegisterAllAreas();，可能需要引入using System.Web.Mvc;。

　　3.添加注释

　　在DefaultController的Get方法上添加注释，然后，运行项目，并修改地址，展示Help页面。此时并没有按照预期显示方法上面的描述。

　　4.显示接口描述

　　取消AreasHelpPageAppStartHelpPageConfig.cs文件中Register方法的部分注释。在项目上点击右键 ->【属性】，选择【Web】选项卡，将启动模式更改为【调试】。重新运行项目，查看Help页面，可以看到接口描述已经显示正常。

　　通过本教程，您应该已经掌握了ASP.NET Web API的基本知识，包括如何在控制台应用程序中托管Web API，以及如何使用HelpPage生成接口描述文档。这将帮助您更好地理解和使用ASP.NET Web API，为您的项目提供强大的服务端功能。

（编辑：台州站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!