Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 1342|回复: 0

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

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-5-9 11:27:52 | 显示全部楼层 |阅读模式

    环境:

    vs2015、win7

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

    生成的help页面如下:,并没有显示控制器和方法。

    原因是:新建项目时候没有勾选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);

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

    结构如下:。这些类都在Dto中,但WebSite在另一个项目中。

    参考:

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

    生成、读取多个xml文件。

    注意:XML路径可以写物理路径,如:D:\git\Smart Find\SmartFind\Lenovo.MediaRepository\App_Data\MediaFacade.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

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2024-12-23 01:29 , Processed in 0.059601 second(s), 29 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表