您的位置:首页 > 编程学习 > 其它 > 正文

使用Visual Studio为WebAPI生成帮助文档

更多 时间:2016-7-13 类别:编程学习 浏览量:1314

使用Visual Studio为WebAPI生成帮助文档

使用Visual Studio为WebAPI生成帮助文档

一、创建 WebApi 项目

 

 

二、找到 HelpPageConfig.cs

 

 

三、将 HelpPageConfig.cs 文件里面的 config.SetDocumentationProvider 代码注释 去掉,修改一下生成的xml文件路径

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

 

四、对项目单击右键,选择属性,按图操作

 

 

五、启动项目,输入Url: localhost:{端口号}/help

 

 

六、上图中连接显示如下

 

 

备注:Description 没有显示内容是因为我们没有在对应的方法上面以 /// 的形式进行注释

 

标签:WebAPI