[webapi] 如何在查看api时显示api的说明

weixin_38166557

于 2014-06-27 16:25:00 发布

阅读量68

点赞数

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/simadi/p/3812243.html

本文介绍如何为WebAPI项目配置文档，包括添加注释、设置文档提供者及预览文档的具体步骤。

首先在Controller的方法中写上相关注释,如下图

然后右击webapi项目点属性.按照下图选择

红色框中内容要保持一致

然后保存.

在项目中找到到这个文件Areas/HelpPage/App_Start/HelpConfig.cs

双击打开,按照下图进行修改

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

然后预览此项目

路径 http://localhost:10643/Help

点击链接进去后

转载于:https://www.cnblogs.com/simadi/p/3812243.html

[webapi] 如何在查看api时 显示api的说明