1、在上一篇【ASP.NET Web API入门教程【5】- 按方法名调用】创建的项目上添加描述文档
2、在项目上点击右键 ->【管理 NuGet 程序包】
3、在NuGet界面,点击【浏览】-> 输入【help】,待搜索完成后,选择【Microsoft.AspNet.WebApi.HelpPage】,在右侧点击【安装】,之后弹出的各种确认框,都点击确定即可 安装完成后,会在项目中增加【Areas】文件夹,并包含很多文件与代码
4、在【Global.asax】文件的【Application_Start】方法中增加【AreaRegistration.RegisterAllAreas();】,可能需要引入【using System.Web.Mvc;】
5、在【DefaultController】的Get方法上添加注释,然后,运行项目,并修改地址,展示Help页面(此时并没有按照预期显示方法上面的描述)
6、【显示接口描述】 1)取消【Areas\HelpPage\App_Start\HelpPageConfig.cs】文件中Register方法的部分注释 2)在项目上点击右键 ->【属性】->【生成】->【输出】-> 勾选【XML 文档文件】,并设置路径 3)在Controller中添加新接口与注释 4)注意:重新编译后,会在【App_Data】文件夹下面生成【XmlDocument.xml】文件,默认并没有包含在项目中,可以点击【显示所有文件】按钮将其包含到项目中,发布时也需要此文件
7、再次运行,即可看到接口的描述,点击接口还可以看到参数等各种详细信息