ASP.NET WebAPI 自动生成帮助文档

时间 2019-11-22

标签 asp.net asp webapi 自动生成帮助文档栏目 ASP 繁體版

原文原文链接

当您建立一个Web API，创建了一个帮助页面很是有用。能够手动建立的全部文件，但最好是可以自动生成。ide

为了使这项工做更容易，ASP.NET Web API提供了自动生成帮助页面的模板，以下图网站

如何建立Help Page？ui

一、用VS2013建立的Web API 2项目会默认带有Microsoft ASP.NET Web API Help Page的包。若是没有，就须要手动去NuGet上安装。spa

二、若是安装了这个包，建立新的Web API 项目后，Web API项目目录里会多一个Area，里面有个HelpPage文件夹，这里面放的都是HelpPage生成器的代码、页面模版和配置文件。3d

当你运行应用程序时，主页上包含一个连接到API帮助页面。code

三、 “Description”字段的内容，是须要去配置的，Description的内容所使用的实际上是代码里方法的注释，即/// <summary>形式的注释。这些东西是能够生成XML的，许多文档生成器都要使用这份XML做为metadata的来源。xml

在咱们的网站里，这样的metadata信息一般应该放在App_Data文件夹里，而不是默认的bin目录里。因此咱们要对Web API的项目属性作一些更改。blog

打开项目属性，在Build页面里，勾选XML documentation file，并把他放到App_Data下面：ip

取消Register方法中第一段代码的注释，而且把XML文件的路径改为刚才在刚才在项目属性页里设置的路径。文档

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

如今，若是你在API方法上添加/// <summary>的注释，就会被生成在网页上。