使用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   
 
 



              
上一篇：mysql中使用show table status 查看表信息
                	  
			  
下一篇：MySQL中使用mysqldump命令备份

  
 


  

      您可能感兴趣
				

					

  
使用Fiddler测试WebApi接口
  
javascript dom事件模型（JavaScript WebAPI、DOM、事件和操作元素实例详解）
  
使用Visual Studio为WebAPI生成帮助文档
  
webapi 参数的传递
辱华品牌新百伦官宣新代言人IU，个别粉丝希望get爱豆同款（辱华品牌新百伦官宣新代言人IU）
巅峰时期被爆床照，曾被选国民最讨厌女星，IU不为人知的黑历史（巅峰时期被爆床照）
每天1万吨牛奶倒进下水道，美国大萧条一幕重现（每天1万吨牛奶倒进下水道）
如何看待美国数十万加仑牛奶倒下水道 历史又重演了（如何看待美国数十万加仑牛奶倒下水道）
历史惊人的相似，美国80万加仑牛奶倒入下水道，意味着什么（历史惊人的相似）
美国数十万加仑牛奶倒进下水道，世界会重演1929年的大萧条吗（美国数十万加仑牛奶倒进下水道）