前言: 你先得知道HelpPageConfig文件,不知道说明你现在不需要这个,所以下文就不用看了,等知道了再看也不急.当然如果你很知道这个,下文也不用看了,因为你会了. 方法一: new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")) 替换成 new XmlDocumentationProvider("PluginsFolder/*.xm…

生成自己的Webapi帮助文档(一) 最近Webapi接口的开发刚刚进入尾声,随之而来的是让用户知道接口的详细参数信息,看过淘宝的接口文档,但网上没找到他的实现方式 虽然新建Webapi时C#也会给你一个帮助文档的Area,但是总觉得有些太复杂了,实用性值得商榷,于是对他做了些阉割,就有了自己的一个版本. 今天只完成了一些基本框架,具体细节有待进一步实现. 总体思路如下: 1:扩展HttpConfiguration的属性来加入自己的帮助文档生成器, 2:在每个Controller中添加该Cont…

最近Webapi接口的开发刚刚进入尾声,随之而来的是让用户知道接口的详细参数信息,看过淘宝的接口文档,但网上没找到他的实现方式 虽然新建Webapi时C#也会给你一个帮助文档的Area,但是总觉得有些太复杂了,实用性值得商榷,于是对他做了些阉割,就有了自己的一个版本. 今天只完成了一些基本框架,具体细节有待进一步实现. 总体思路如下: 1:扩展HttpConfiguration的属性来加入自己的帮助文档生成器, 2:在每个Controller中添加该Controller的帮助信息 3:查看HTM…

如何建 .netcore webapi 项目这个就不说了,这个都没有没必要看下去. 我这里是.netcore 2.0,虽然没测过1.0的,但想来差不多. 1.Nuget Packages安装,使用程序包管理器控制台,安装命令:Install-Package Swashbuckle.AspNetCore -Pre 或者搜索安装  Swashbuckle.AspNetCore.Swagger 2.生成项目xml文档,多项目的情况下 3.配置Startup.cs.为了直观,我把整个类贴这里了,具体功能…

ASP.NET WebAPI使用Swagger生成测试文档 SwaggerUI是一个简单的Restful API测试和文档工具.简单.漂亮.易用(官方demo).通过读取JSON配置显示API .项目本身仅仅也只依赖一些html,css,js静态文件.你可以几乎放在任何Web容器上使用 捣鼓了好久最终效果如下 1.API控制器和action描述 2.测试接口 使用swagger 1.创建webapi项目解决方案 2.引用swagger nuget包 swashbuckle和swagger.NET…

在做webapi项目的时候 webapi为我们提供了help文档,开发者可以参考这个文档,但是这个文档缺少测试功能,如果加上一个测试的功能就更加方便了 于是就研究了下写了一段代码,代码比较简单,只要将这段代码贴在areas\helppage\views\help\api.cshtml中就可以了,如果多个api项目都依次加上,因为感觉比较实用就分享出来 如果你的接口不需要验证,请自行修改下代码,测试时可以复制文档中提供的参数格式进行修改 <div id="test"> <…

Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什么选择swagger,现在的网站开发结果越来越注重前后端的分离,比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离.就算再如何的分离实现,也是不可避免的要进行数据交互的,那么接口的重要性就提现出来了.他成了前端和后端交互的重要途径,API文档也因此成了前端开发人员与后端开发人员的重要纽带.…

1.找到已经成功安装过的项目根目录的packages文件夹拷贝到新的项目的根目录 2.vs设置nuget程序包源 将源:地址改为新项目的packages文件夹 3.重新编译并修改代码 右键项目->属性->生成->输出 勾上xml文档文件(x)记录下xml文档的文件名(如website.xml) 并重新编译 找到app_start文件夹,打开swaggerconfig.cs搜索如下代码: c.IncludeXmlComments(GetXmlCommentsPath()) 将本行的注释取消…

经过今天一上午的修改,已经有个基础的框架了,其它功能只能是在实际使用中发现一个修改一个了. 以下是生成的结果示例: 相比昨天,几个Model都有修改,这里就不一一贴代码了,放个代码包上来,有需要的自己去查看. 整个代码的核心:生成序列化字符串,微软支持的并不好,不能缩进. static string GetSerializationString(string formatter, Type inputType, object input) { try { var serializerSettin…

nuget安装Swashbuckle包 修改SwaggerConfig文件 //c.IncludeXmlComments(GetXmlCommentsPath()); //设置接口描述xml路径地址 c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory)); 给接口添加注释,即可看到参数及方法描述了       http://w…