.net WebApi 文档注释

默认情况下新建的Web Api 2项目,自带的Help页下会显示Api的相关信息,但Description那一栏无法获取到数据,如下图所示:

解决方式:1.先启用输出的XML文档文件:

在web api 项目上右击->属性,在属性页"生成"标签下,勾选输出下面的"XML 文档文件",如下图所示:


2.在项目里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,并把地址改成与1里的对应,如下图所示:


3.在Api上添加注释,如下图所示:


再次运行项目,打开Api Help页面,就可以看到效果了,如下图所示:


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 174,539评论 25 709
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,256评论 19 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,999评论 6 342
  • 微信小程序开放注册了,注册地址:https://mp.weixin.qq.com/wxopen/waregiste...
    充电实践阅读 274评论 0 0
  • 日月当空照 不知秋雨近 最是离别时 才知情更怯 口中无言语 心中永想念 梦中悔当初 错把情意过 愿你意志坚 了却心...
    樊勇明阅读 92评论 0 0