为ASP.Net WebAPI 添加HelpPage页面

2020-10-10 20:02:04 115 收藏
分类专栏： ASP.NET 后端开发 文章标签： asp.net api web c#
最后发布:2020-10-10 20:02:04首次发布:2020-10-10 20:02:04
版权声明：本文为博主原创文章，遵循<a href="http://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener"> CC 4.0 BY-SA </a>版权协议，转载请附上原文出处链接和本声明。
本文链接：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博客专家，本科大四在读。江苏省第四届“互联网+”大学生创新创业大赛二等奖获得者，第二届、第三届微信小程序应用开发大赛全国三等奖、华东赛区二等奖项目作者，微信小程序《约车吗》、《庆云慈善会》、《锋云速检》项目工程师。
已标记关键词 清除标记
ASP.Net WebAPI中添加helppage帮助页面
weixin_30621919的博客
04-13 116
一、自动创建带帮助的WebAPI 1、首先创建项目的时候选择WebAPI,如下图所示，生成的项目会自动生成帮助文档。 2、设置调用XML文档的代码 3、设置项目注释XML文档生成目录，项目——属性——生成——勾选生成XML文档——设置目录为App_Data 4、Values控制器中的代码 1 /// <summary> 2 /// V...
表情包
插入表情
还能输入1000个字符 “速评一下”
ASP.NET WEB API help page 显示description
xue251248603的专栏
05-09 1148
1、Areas/HelpPage/App_Start/HelpPageConfig.cs 修改 public static void Register(HttpConfiguration config)： config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath...
.NET CORE WebAPI 增加默认页面功能
大乔技术笔记
07-12 3381
目录 功能描述 核心配置代码 核心代码 功能描述 因为.NET CORE WebAPI 是基于MVC 但是它主要是提供数据结构支持不提供VIEW操作，所以默认是不具备默认页面显示功能的；如果需要显示默认页面请增加代码到 Startup 类中。 核心配置代码 public class Startup { public Startup(IConfigurati...
如何给你的ASP.NET页面添加HelpPage
weixin_33953384的博客
04-18 21
如何给你的ASP.NET页面添加HelpPage 　　最近写了一些webAPI，所以需要搞一套API的帮助文档，google了一下，发现这是可以自动生成的，以下就是如何自动生成HelpPage的说明。 　　参考：http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages 　　其实我也是按照上面的说...
HelpPage
weixin_38167826的博客
09-23 16
http://www.cnblogs.com/pmars/p/3673654.html如何给你的ASP.NET页面添加HelpPage WebApi_HelpPagehttp://www.cnblogs.com/gossip/p/4546630.html WebAPI使用多个xml文件生成帮助文档(转) Web API 版本控制的几种方式http://blog.csdn...
MyBatis-扩展-PageHelpler分页插件使用
470341698的博客
11-18 9723
• PageHelper是MyBatis中非常方便的第三方分页插件。 • 官方文档： https://github.com/pagehelper/MybatisPageHelper/blob/master/README_zh.md • 我们可以对照官方文档的说明，快速的使用插件   使用步骤 • 1、导入相关包pagehelper-x.x.x.jar和 jsqlparser-0.
C# HelpPage 接口文档配置
weixin_30947043的博客
09-19 162
1、打开项目路径如下的类文件： 1.1、找类方法Register 下的config.SetDocumentationProvider 并取消注释，修改~/App_Data/XmlDocument.xml 为你自己的路径， config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Curren...
Wei API HelpPage 帮助页描述
weixin_34297704的博客
03-07 73
输出XML文档 增加HelpPage注册xml方法 public static void Register(HttpConfiguration config) config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Da...
WebAPI隐藏默认首页
a_dev的专栏
04-03 1089
需求背景 某项目需要通过WebAPI提供GIS接口服务。开发完成，部署到客户机后，客户又提出，不希望人们能够通过IP+端口号的方式直接访问到接口服务网站，以免直接在接口页面进行测试或操作，导致数据安全方面的问题。 比如，接口部署好后，通过浏览器中输入IP和端口，可以访问到接口服务网站： 并可以进一步访问接口信息： 而客户希望看到的效果是，无论直接输入IP加端口，还是进一步访问接口页...
关于ASP.NET Web Api的HelpPage文档注释问题
给您添蘑菇了的博客
03-04 517
关于ASP.NET Web Api的HelpPage文档注释问题 以前我用微软的HelpPage来自动生成的webAPI帮助文档。在使用了一段时间后发现只能显示Controller上面写的注释文档内容。以前总以为是微软这个类库的bug。后来才明白了是由于我的设置不当。   微软的HelpPage类库     control
怎样让引用类库的类在HelpPage上显示Description
择飞
12-21 1366
1、对引用的类库右键，属性，在生成里面点击“XML文档文件”，定义好生成的XML文件路径 （ Web API 项目也要设置XML文档输出文件，这里我是 XmlDocument.xml ）         2、把类库的 XML 文件拷贝到 Web API 项目的 App_Data 文件夹下，并包含在项目中，这样就应该有两个XML文件
WebApi 之HelpPage帮助页
anji7253的博客
03-06 33
1.创建解决方案 2.选择类型-Web API 3.设置项目生成XML路径 同时修改HelpPageConfig,代码调用XML文件位置 3.编写WebApi接口代码 4.启动项目 查看接口 5.测试接口(添加WebApiTestClient组件) 安装完成之后,修改Api.cshtml文件 这个时候再运行项目就会发现API...
Asp.net Web Api开发（第四篇）Help Page配置和扩展
一叶知秋
09-30 8695
为了方面APP开发人员，服务端的接口都应当提供详尽的API说明。但每次有修改，既要维护代码，又要维护文档，一旦开发进度紧张，很容易导致代码与文档不一致。Web API有一个Help Page插件，可以很方便的根据代码及注释自动生成相关API说明页面。Help Page安装步骤及扩展(以VS2015为例)：右键点击WebAPI项目的引用，选择"管理NuGet程序包"在搜索框中输入 helppage进...
HelpPage 与 Swagger UI使用笔记
yyNet2014的博客
01-12 1168
HelpPage 与 Swagger UI使用笔记 前言 很显然，又是前后端分离流程的附带问题解决（也可能以前的Web API都是后端自己用的，有没有文档无所谓）。 公司刚开始实行前后端分离时后端使用的API文档是chm类型的，可读性程度想想都是泪。后来想推Swagger又遇到了统一返回值的问题，再加上项目时间紧张就一直放着没去研究。这两天看了下Help Page提供的代码，终于找到返回
大数据的入门视频教程
07-26
大数据技术入门视频课程，会从基础思想和原理架构开始，全面介绍大数据的思想体系和架构，为学员进一步学习大数据奠定良好的基础。内容涉及大数据的核心问题、大数据核心思想，Google的三篇论文、GFS，Google的分布式文件系统，MapReduce，BigTable、Hadoop和Spark生态体系以及具体应用演示。
8小时Python零基础轻松入门
05-20
 
©️2020 CSDN 皮肤主题: 技术工厂 设计师:CSDN官方博客 返回首页