visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决

摘要:
App missing_ Start下的WebApiConfig.cs文件如下所示。要显示Action,请将其更改为routeTemplate:“api/{controller}/{Action}/{id}”,publicstaticclassWebApiConfig{publicstaticvoidRegister{//WebAPIconfigurationandservices/WebAPIroutesconfig.MapHttpAttributes();config.Routes.MapHttpRoute;}}缺少GlobalConfiguration.config in Global.asax;此外,当post-request类或return类在另一个项目中时,需要生成并读取多个xml文件以显示这些类的注释。

环境:

vs2015、win7

参考:http://www.cnblogs.com/Erik_Xu/p/5638381.html

生成的help页面如下:visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决第1张,并没有显示控制器和方法。

原因是:新建项目时候没有勾选Web Api,webapi是后来添加的。缺少App_Start下的WebApiConfig.cs文件,如下。要显示Action,更改为 routeTemplate: "api/{controller}/{action}/{id}",

 public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API configuration and services

            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }

缺少Global.asax中的 GlobalConfiguration.Configure(WebApiConfig.Register);

visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决第2张

 另:当post请求类或返回类在另一个项目中时候,需要生成、读取多个xml文件才能够显示这些类的注释。

结构如下:visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决第3张。这些类都在Dto中,但WebSite在另一个项目中。

参考:

关于Web Api的HelpPage文档注释问题

生成、读取多个xml文件。

注意:XML路径可以写物理路径,如:D:gitSmart FindSmartFindLenovo.MediaRepositoryApp_DataMediaFacade.xml

 另外,如果不想action显示在help页面,注释

 /// <summary>
        /// 用户信息。获取当前登录用户token
        /// </summary>
        /// <returns></returns>
        [ApiExplorerSettings(IgnoreApi = true)]
        [AllowAnonymous]
        public string GetCurrentToken()
        {
            HttpRequest request = HttpContext.Current.Request;
            return request.Headers["x-auth-token"];
        }

  Swashbuckle

免责声明:文章转载自《visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Python学习笔记:SQL中group_concat分组合并操作实现UVM基础之---------uvm report 机制分析下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

aspnet webapi 跨域请求 405错误

跨域,请求按要求配置完毕之后,options预请求老是报错。原因是webapi 默认的web.config有配置 <handlers><remove name="ExtensionlessUrlHandler-Integrated-4.0" /><remove name="OPTIONSVerbHandler" />&...

Notepad++加上xml格式化的功能

工作中需要用代码创建一个XML文件,创建完发现XML内容都处在同一行,导致非常不容易查看清楚XML代码。于是习惯性地用 Notepad++查看,想用它来对XML代码格式化一下。 于是找到了TextFX characters这个插件,可是该插件安装后不能正常使用,点击重载libTidy.dll这个文件,系统提示缺少libTidy.dll这个文件。   既然是...

Android 三种动画详解

Android 三种动画详解 1 背景 不能只分析源码呀,分析的同时也要整理归纳基础知识,刚好有人微博私信让全面说说Android的动画,所以今天来一发Android应用的各种Animation大集合。英文厉害的请直接移步参考Android Developer。 Android系统提供了很多丰富的API去实现UI的2D与3D动画,最主要的划分可以分为如...

CDATA(不应由XML解析器进行解析的文本数据)、CDATA的使用场景

1.1. CDATA: CDATA(Unparsed Character Data)指的是不应由XML解析器进行解析的文本数据。 因为XML解析器会将“<”(新元素的开始)和“&”(字符实体的开始)解析成具有特殊含义的字符,所以如果在文本中需要使用这些字符时,就必须使用实例引用去代替。但是有些文本,如JavaScript代码中会包含大量的“...

配置Tomcat的server.xml编码为UTF-8时,再次发布项目,编码自动还原问题?

当我们在处理中文乱码或是配置数据源时,我们要修改Tomcat下的server.xml 但是当我们修改完后重启Tomcat服务器时发现xml文件又被还原了,修改无效果。 为什么会还原? Tomcat服务器在Eclipse中启动时,会自动发布Eclipse中部署的项目,但是我的项目是自己手动在外面部署的,Eclipse只认得在它里面部署的项目,因此它会创建一个...

webapi的返回类型,webapi返回图片

1.0 首先是返回常用的系统类型,当然这些返回方式不常用到。如:int,string,list,array等。这些类型直接返回即可。 1 public List<string> Get() 2 { 3 List<string> list = new List<string>() {...