为ASP.Net WebAPI 添加HelpPage页面

2020-10-10 20:02:04 163 收藏
分类专栏： ASP.NET 后端开发 文章标签： asp.net api web c#
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yuanxiang01/article/details/109003203
版权

  1. 创建ASP.NET WebAPI项目；
    在这里插入图片描述

  2. 为函数添加注释；
    在这里插入图片描述

  3. 在项目上右键-属性
    在这里插入图片描述

  4. 点击“生成”，对输出内容进行设置，勾选“XML文档文件”,并且设置内容为“App_Data\XmlDocument.xml”
    在这里插入图片描述

  5. 打开文件 /Areas/HelpPage/App_Start/HelpPageConfig.cs，将第37行注释去掉；
    在这里插入图片描述

  6. 右键项目-“生成”，访问Help页面即可看到在程序中写的注释信息。
    在这里插入图片描述

daixiangcn CSDN认证博客专家 后端开发工程师 产品体验官
中国公民，中共预备党员，CSDN博客专家，本科大四在读。江苏省第四届“互联网+”大学生创新创业大赛二等奖获得者，第二届、第三届微信小程序应用开发大赛全国三等奖、华东赛区二等奖项目作者，微信小程序《约车吗》、《庆云慈善会》、《锋云速检》项目工程师。
已标记关键词 清除标记
WebAPI应用支持HTTPS的经验总结
02-20
在我前面介绍的WebAPI文章里面，介绍了WebAPI的架构设计方面的内容，其中提出了现在流行的WebAPI优先的路线，这种也是我们开发多应用（APP、微信、微网站、商城、以及Winform等方面的整合）的时候值得考虑的线路之一。一般情况下，由于HTTP协议的安全性，传递的参数容易被拦截，从而可能导致潜在的危险，所以一般WebAPI接口层都采用了HTTPS协议的，也就是采用SSL层来对数据进行安全性的加密的。HTTPS（全称：HypertextTransferProtocoloverSecureSocketLayer），是以安全为目标的HTTP通道，简单讲是HTTP的安全版。即HTTP下加入S
表情包
插入表情
还能输入1000个字符
相关推荐
.NET CORE WebAPI 增加默认页面功能
大乔技术笔记
07-12 3740
目录 功能描述 核心配置代码 核心代码 功能描述 因为.NET CORE WebAPI 是基于MVC 但是它主要是提供数据结构支持不提供VIEW操作，所以默认是不具备默认页面显示功能的；如果需要显示默认页面请增加代码到 Startup 类中。 核心配置代码 public class Startup { public Startup(IConfigurati...
ASP.Net WebAPI中添加helppage帮助页面
weixin_30621919的博客
04-13 135
一、自动创建带帮助的WebAPI 1、首先创建项目的时候选择WebAPI,如下图所示，生成的项目会自动生成帮助文档。 2、设置调用XML文档的代码 3、设置项目注释XML文档生成目录，项目——属性——生成——勾选生成XML文档——设置目录为App_Data 4、Values控制器中的代码 1 /// <summary> 2 /// V...
如何给你的ASP.NET页面添加HelpPage
weixin_33953384的博客
04-18 24
如何给你的ASP.NET页面添加HelpPage 　　最近写了一些webAPI，所以需要搞一套API的帮助文档，google了一下，发现这是可以自动生成的，以下就是如何自动生成HelpPage的说明。 　　参考：http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages 　　其实我也是按照上面的说...
Asp.net Web Api开发（第四篇）Help Page配置和扩展
一叶知秋
09-30 8876
为了方面APP开发人员，服务端的接口都应当提供详尽的API说明。但每次有修改，既要维护代码，又要维护文档，一旦开发进度紧张，很容易导致代码与文档不一致。Web API有一个Help Page插件，可以很方便的根据代码及注释自动生成相关API说明页面。Help Page安装步骤及扩展(以VS2015为例)：右键点击WebAPI项目的引用，选择"管理NuGet程序包"在搜索框中输入 helppage进...
asp.net WebApi 返回html页面
日志
08-24 6088
asp.net WebApi 返回html页面 public HttpResponseMessage Get(string id) { if (id.Contains("OID=")) { id = id.Replace("OID=", ""); } ...
mvc webapi项目中aspx页面无法打开问题（微信回调）
a1234012340a的博客
07-21 250
因为微信回调我们用的事这种形式 所以微信请求此页面后台写跳转。回调接口 再一次发布中。出现回调异常。并且log中无任何请求痕迹 发现，经一系列调查。发现没有头绪。灵光一闪打算手动模拟微信回调 然而出现如下报错 纳尼？ 根据我多年asp.net的学习经验。学校知识得到。这不应该啊。应该直接能访问的才对 根据他的提示打开异常报错，发现404.并没有卵用 继续调查。使用local...
C# HelpPage 接口文档配置
weixin_30947043的博客
09-19 180
1、打开项目路径如下的类文件： 1.1、找类方法Register 下的config.SetDocumentationProvider 并取消注释，修改~/App_Data/XmlDocument.xml 为你自己的路径， config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Curren...
Asp.net Web Api开发（第四篇）Help Page配置和扩展
weixin_34066347的博客
05-25 38
为了方面APP开发人员，服务端的接口都应当提供详尽的API说明。但每次有修改，既要维护代码，又要维护文档，一旦开发进度紧张，很容易导致代码与文档不一致。 Web API有一个Help Page插件，可以很方便的根据代码及注释自动生成相关API说明页面。示例DEMO下载：http://pan.baidu.com/s/1nvbG0XV Help Page安装步骤及扩展(以VS2015为例)： 右键点击...
如何给你的ASP.NET页面添加HelpPage
10-17
自动生成webapi说明文档，免除写api帮助文档的尴尬
怎样让引用类库的类在HelpPage上显示Description
择飞
12-21 1386
1、对引用的类库右键，属性，在生成里面点击“XML文档文件”，定义好生成的XML文件路径 （ Web API 项目也要设置XML文档输出文件，这里我是 XmlDocument.xml ）         2、把类库的 XML 文件拷贝到 Web API 项目的 App_Data 文件夹下，并包含在项目中，这样就应该有两个XML文件
女神相册密码忘记了，我只用Python写了20行代码~~~
lexsaints
04-10 2万+
​目录 一、事情是这样的 二、首先回顾一下女神的操作流程 三、需要密码打开相册 四、python脚本化处理 1、基本思路 2、解压命令 3、解压命令参数分析 4、整理7z解压命令 5、关门！上python脚本 五、找女神去... 一、事情是这样的 今早上班，公司女神小姐姐说，她去年去三亚旅游的照片打不开了 好奇问了一下才知道。 原来是，她把照片压缩了，而且还加了密码。 但是密码不记得了，只记得是一串6位数字。 话说照片压缩率也不高，而且还加密，难道是有什么可爱的小照片 .
垃圾分类数据集及代码
11-11
资源说明： 数据集主要包括6类图片：硬纸板、纸、塑料瓶、玻璃瓶、铜制品、不可回收垃圾 代码运行说明： 1、 安装运行项目所需的python模块，包括tensorflow | numpy | keras | cv2 2、 train.py用于训练垃圾分类模型，由于训练的数据量过于庞大，因此不一并上传 3、 predict.py用于预测垃圾的类别，首先运行predict.py，然后输入需要预测的文件路径，即可得到结果。
高并发下的Nginx性能优化实战
12-24
<p> <b><span style="background-color:#FFE500;">【超实用课程内容】</span></b> </p> <p> <br /> </p> <p> <br /> </p> <p> 本课程内容包含讲解<span>解读Nginx的基础知识，</span><span>解读Nginx的核心知识、带领学员进行</span>高并发环境下的Nginx性能优化实战，让学生能够快速将所学融合到企业应用中。 </p> <p> <br /> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b><br /> </b> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b><span style="background-color:#FFE500;">【课程如何观看？】</span></b> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> PC端：<a href="https://edu.csdn.net/course/detail/26277"><span id="__kindeditor_bookmark_start_21__"></span></a><a href="https://edu.csdn.net/course/detail/27216">https://edu.csdn.net/course/detail/27216</a> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 移动端：CSDN 学院APP（注意不是CSDN APP哦） </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 本课程为录播课，课程永久有效观看时长，大家可以抓紧时间学习后一起讨论哦~ </p> <p style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <br /> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <strong><span style="background-color:#FFE500;">【学员专享增值服务】</span></strong> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b>源码开放</b> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 课件、课程案例代码完全开放给你，你可以根据所学知识，自行修改、优化 </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 下载方式：电脑登录<a href="https://edu.csdn.net/course/detail/26277"></a><a href="https://edu.csdn.net/course/detail/27216">https://edu.csdn.net/course/detail/27216</a>，播放页面右侧点击课件进行资料打包下载 </p> <p> <br /> </p> <p> <br /> </p> <p> <br /> </p>
看完这些面试必问的Linux小知识，我保证你面试后会来给我的文章一键三连
万里羊的博客
04-09 5874
本文整理了校招中经常问的Linux常问问题，并有详细的答案解析，希望对校招相关工作的小伙伴有帮助
Java学习指南（Java入门与进阶）
08-09
<p> 这是Java学习指南系列课程的第1篇，介绍Java语言的入门语法，引领希望学习Java语言编程的初学者进入Java大门。 </p> <p> 本课程不需要其他语言作为基础，可以直接学习。 </p> <p> 课程从Java开发平台的下载和安装开始，从浅到深、从易到难，循序渐进地进行语法讲解。 </p> <p> 为了让学员更好的掌握Java语言，本课程配套在线的Java题库及答案解析。 </p> <p> 相比于其他语言，Java语言更科学、更容易掌握，快来和大家一起学习Java吧。 </p>
asp.net web api帮助文档的说明
Yunying的专栏
05-30 4904
asp.net web api帮助文档的说明
©️2020 CSDN 皮肤主题: 技术工厂 设计师:CSDN官方博客 返回首页