WebApi 生成帮助文档及顺便创建简单的测试工具

http://www.2cto.com/kf/201607/522971.html

　==========最终的效果图==========

==========下面开始干活==========

一、创建 WebApi 项目

二、找到 HelpPageConfig.cs 并取消代码注释

1	`1` `config.SetDocumentationProvider(` `new` `XmlDocumentationProvider ( HttpContext.Current.Server.MapPath(` `"~/App_Data/XmlDocument.xml"` `)));`

三、对项目单击右键，选择属性，按图操作

四、启动项目，输入Url： localhost:{端口号}/help

　　【注】Description 没有显示内容是因为我们没有在对应的方法上面以 /// 的形式进行注释

==========下面是顺便创建简单测试工具的分割线==========

一、对项目单击右键，选择“管理 NuGet 程序包”，搜索一下“apitest”

二、装完之后再启动进去查看方法，就会发现右下角有个按钮“Test api”

时间： 2024-12-18 15:17:04

WebApi 生成帮助文档及顺便创建简单的测试工具的相关文章

.NET：WebApi 生成帮助文档及顺便创建简单的测试工具

==========最终的效果图========== ==========下面开始干活:生成帮助文档========== 一.创建 WebApi 项目二.找到 HelpPageConfig.cs 并取消代码注释 1 config.SetDocumentationProvider( new XmlDocumentationProvider ( HttpContext.Current.Server.MapPath( "~/App_Data/XmlDocument.xml" ))); 三.

Asp.net WebApi 生成SwaggerUI文档

我们为什么需要文档好的文档能够让前后端开发沟通更轻松 Swagger ui 文档的优点可在线测试的,方便前后端调试使用步骤新建WebApi 项目 Nuget 引入相应的类库 Install-Package Swashbuckle (swaggerui 2.0) 引入之后,会在App_Start 目录生成 SwaggerConfig.cs 文件修改 SwaggerConfig.cs 文件 c.IncludeXmlComments 函数,引入需要包含的 xml 文件(c# summary

利用PDFLib生成PDF文档

本文代码生成的PDF文档效果图一.PDF介绍 PDF是Portable Document Format的缩写,PDF文件格式是国际通用的电子文档交换事实标准,被许多国家采用作为电子文档交换.PDF文件可以在各种平台下阅读.编辑.发布.该文件格式支持字体.图像.甚至任何附件的嵌入.您可以通过免费的Adobe Acrobat Reader来阅读.编辑PDF文档. 二.PDFLib介绍 PDFLib是用于创建PDF文档的开发库,提供了简单易用的API,隐藏了创建PDF的复杂细节且不需要第3方软件的支

利用OpenXml生成Word2007文档

一.OpenXml简介利用C#生成Word文档并非一定要利用OpenXml技术,至少可以使用微软提供的Office相关组件来编程,不过对于Office2007(确切的说是Word.Excel和PowerPoint2007)及以上版本,微软提供了这些信息组织的另外一种思路:OpenXml技术. OpenXml是微软office2007及之后版本里,对Office信息内容(Word.Excel和PowerPoint)的一种组织方式,当你创建一个Word2007文档:XXX.docx后,它实际上是一

使用PDFLib生成PDF文档教程

一.PDF介绍PDF是Portable Document Format的缩写,PDF文件格式是国际通用的电子文档交换事实标准,被许多国家采用作为电子文档交换.PDF文件可以在各种平台下阅读.编辑.发布.该文件格式支持字体.图像.甚至任何附件的嵌入.您可以通过免费的Adobe Acrobat Reader来阅读.编辑PDF文档. 二.PDFLib介绍PDFLib是用于创建PDF文档的开发库,提供了简单易用的API,隐藏了创建PDF的复杂细节且不需要第3方软件的支持.PDFLib库对于个人是免费的,

webAPI 自动生成帮助文档

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文档. 1.下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述. 2.点击红框内的链接,打开api方法的详情页面,如下图所示, 3.点击Test API打开如下页面 4.输入参数,点击S

asp.net webAPI 自动生成帮助文档并测试

WebAPI使用多个xml文件生成帮助文档

一.前言上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的.在我们的项目帮助文档需要的类(特指定义的Request和Response)与项目在同一个项目时是没有问题的,但是我们实际工作中会因为其他项目也需要引用该(Request和Response)时,我们会将其抽出来单独作为一个项目供其它调用来引用,这时,查看帮助文档不会报

【转】WebAPI使用多个xml文件生成帮助文档

来自:http://www.it165.net/pro/html/201505/42504.html 一.前言上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的.在我们的项目帮助文档需要的类(特指定义的Request和Response)与项目在同一个项目时是没有问题的,但是我们实际工作中会因为其他项目也需要引用该(Reque