在vs2015 里面生成的WebAPI项目 默认包含一个自动生成API说明文档的功能.
但是里面的方法注释和文档注释默认是不存在的.
百度了一下, 找到了解决方法. 生成的效果如下.
首先要配置项目可以生成XML说明文档..
右击你的项目->生成->输出->勾上 XML文档文件 然后把这个文件名放在下面的代码里.
然后 在Areas/HelpPage/App_Start/HelpPageConfig.cs 文件中目前应该是第62行. 增加下面的代码
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/你的项目生成的.XML")));
在你的方法上加上说明文档例如:
/// <summary>
/// 获取用户信息,这个就会显示在说明文档里面
/// </summary>
/// <returns></returns>
// GET api/Account/UserInfo
[HostAuthentication(DefaultAuthenticationTypes.ExternalBearer)]
[Route("UserInfo")]
public UserInfoViewModel GetUserInfo()
{
ExternalLoginData externalLogin = ExternalLoginData.FromIdentity(User.Identity as ClaimsIdentity);
return new UserInfoViewModel
{
Email = User.Identity.GetUserName(),
HasRegistered = externalLogin == null,
LoginProvider = externalLogin != null ? externalLogin.LoginProvider : null
};
}
然后就可以了.