启用WebApi 2里的Api描述信息(Help下的Description)

环境:vs2013+web api 2

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

解决:

1.先启用输出的XML文档文件:

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

2.在"解决方案管理器"里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,并把地址改成与1里的对应,如下图所示:

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

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

参考:ASP.NET Web API Help Page documentation using Xml comments on controllers

启用WebApi 2里的Api描述信息(Help下的Description)相关推荐

Hybris commerce里用web service为什么查询不到产品的描述信息
Hybris Commerce里的产品描述信息维护是基于某一种语言的,因此用web service查询时,在postman的请求里需要加上一个名为"lang"的参数,然后值等于语言 ...
淘宝API分享：获取淘宝商品描述信息
淘宝中的商品详情信息都是经过专业美工整理的,介绍也很直观明了.最近在想,如果能够直接获取到商品详情介绍的数据,那么对于电商用户来说,是非常省时省力的.还真让我琢磨出来了一个专门用来获取商品描述信息的A ...
core webapi缩略图_在ASP.NET Core Web API 项目里无法访问（wwwroot）下的文件
新建 ASP.NET Core Web API 项目 -- RESTFul 风格 Hello World! 一.创建一个空项目请查看新建 .NET Core 项目 -- Hello World! ...
ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
【转】ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
原文链接:https://www.cnblogs.com/yilezhu/p/9241261.html 引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必 ...
腾讯地图api修改信息窗口样式_DOTA2 地图编辑器指南（二）：总览
做什么地图作为一个打算把流程讲得详细一点的教程,是不太好做什么庞大的项目的.我们的目的还是学会制作工具和熟悉制作流程,只要学会了工具,就有能力实现自己心目中的项目了.到时候更加要求的其实是创意. 所 ...
第十二节：WebApi自动生成在线Api文档的两种方式
一. WebApi自带生成api文档 1. 说明通过观察,发现WebApi项目中Area文件夹下有一个HelpPage文件夹,如下图,该文件夹就是WebApi自带的生成Api的方式,如果该文件夹没了 ...
SAP MM 如何取到供应商付款条款描述信息？
SAP MM 如何取到供应商付款条款描述信息? 笔者参与的项目里,客户需要打印自己自定义格式的PO FORM.笔者在撰写PO FORM的功能说明书的时候,遇到了一个问题,在指定Payment Term ...
Paste Image插件初始化设置：修改图片保存路径、自动插入图片描述信息
Paste Image插件初始化设置:修改图片保存路径.自动插入图片描述信息 Paste Image插件默认将图片保存于所编辑的Markdown文档的当前目录下,若插入的图片较多,会导致该目录下显得杂 ...

启用WebApi 2里的Api描述信息(Help下的Description)

启用WebApi 2里的Api描述信息(Help下的Description)相关推荐

最新文章

热门文章