Web API使用记录系列（二）HelpPage优化与WebApiTestClient

　　继续使用记录的第二节，HelpPage的优化与测试工具WebApiTestClient的使用。

　　之前没怎么整理博客，都是记录一下笔记，真正好好整理发现没想像的那么简单。不管怎么说还是培养下写博客的习惯吧，不管写的好与不好，学习了总要分享一下才对，开干！

　　本节目录

　　HelpPage页面修改+自定义api列表

　　　页面修改

　　　显示备注与Model的描述信息

　　　自定义api列表

　　测试工具WebApiTestClient的使用

　　　安装与配置

　　　固定header参数处理

　　正文开始！

　　一、HelpPage页面修改+自定义api列表

　　如果使用的较低版本的api，没有HelpPage的话可以使用nuget安装HelpPage　　

install-package Microsoft.AspNet.WebApi.HelpPage

　　1.页面基本的文字样式等修改

　　我这里为了截图方便之更改了文字信息，个人可根据自己的需要修改

　　 Web API使用记录系列（二）HelpPage优化与WebApiTestClient

　　黑色背景部分的文件在根目录Views/Shared/_Layout.cshtml，不是helppage下的模板页

　　中间内容区域是HelpPage下的Index.cshtml页面

　　2.显示备注与Model的描述信息

　　第一步：生成XML文件，右键项目--属性--生成选项卡（左侧）--输出模块（右侧），勾选XML文档文件，并配置路径和文件名

　　 Web API使用记录系列（二）HelpPage优化与WebApiTestClient

　　第二步：修改HelpPage的配置信息（HelpPage/App_Start/HelpPageConfig.cs），将Register中的下面这句话取消注释，并将MapPath中的文件地址改成第一步中配置的

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/SampleAPI.xml")));

　　启动项目，再看一下Help页面Api列表中是不是已经显示出了你的备注内容，嘿嘿~

　　扩展：

　　①泛型Model的属性备注内容不显示

　　方案：修改XmlDocumentationProvider.cs中的方法GetTypeName，在string genericTypeName = genericType.FullName;后直接return.　　

1 Type[] genericArguments = type.GetGenericArguments();
2 string genericTypeName = genericType.FullName;
3 
4 return genericTypeName;  //处理泛型不显示注释问题

View Code