webapi help文档 添加测试功能】的更多相关文章

在做webapi项目的时候 webapi为我们提供了help文档,开发者可以参考这个文档,但是这个文档缺少测试功能,如果加上一个测试的功能就更加方便了 于是就研究了下写了一段代码,代码比较简单,只要将这段代码贴在areas\helppage\views\help\api.cshtml中就可以了,如果多个api项目都依次加上,因为感觉比较实用就分享出来 如果你的接口不需要验证,请自行修改下代码,测试时可以复制文档中提供的参数格式进行修改 <div id="test"> <…
最近发现一个比较好用的插件,可根据api的功能注释说明一键生成文档以及功能demo: swaggerUI 是一个简单的Restful API 测试和文档工具.简单.漂亮.易用.通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用. 这里可以直接创建一个默认的项目: 添加nuget 组件库 Swashbuckle 代码注释生成文档说明.Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUI,…
背景:接到一个项目,要求文档管理,当然文档库就可以了,但是要求文档需要大家去读,读完以后还可以发表评论,这Moss貌似就有点困难了.和同事一起合计,想来想去也没有太好的办法,后来想到传统开发,两个表的级联,就想到了文档库和列表库通过一个字段进行级联,废话不多说了,进入正题. 1. 首先,新建一个文档库,这不是废话么:然后,再建一个列表库用来保存文档的评论:当时我在想,对于一个文档什么才是唯一的,后来想到,这么简单,不就是ID么,又是废话了,呵呵.我们要做的就是通过文档库中文档的ID进行级联. 2…
1.找到已经成功安装过的项目根目录的packages文件夹拷贝到新的项目的根目录 2.vs设置nuget程序包源 将源:地址改为新项目的packages文件夹 3.重新编译并修改代码 右键项目->属性->生成->输出 勾上xml文档文件(x)记录下xml文档的文件名(如website.xml) 并重新编译 找到app_start文件夹,打开swaggerconfig.cs搜索如下代码: c.IncludeXmlComments(GetXmlCommentsPath()) 将本行的注释取消…
https://blog.csdn.net/foren_whb/article/details/78866133…
容器环境下将NuGet包XML文档添加到Swagger 在.NET Core项目开发过程中,为了实现代码复用,我们将可以重复使用的部分拆分成一个个小的NuGet包.这些NuGet包可以在其他系统中复用,这样我们只需要实现系统特定的代码,其余部分的就可以重用了,包括功能.文档等.使用过程中,功能复用没有遇到任何问题,但是文档复用却遇到了问题.我们使用SwashBuckle生成Swagger定义和Swagger UI.Swashbuckle需要XML文档,才能显示控制器和模型的文档说明.不幸的是,S…
根据接口文档来测试 1.get请求…
PDF 补丁丁 0.4.1 版新增了嵌入中文字库.替换文档字库的功能. 嵌入汉字字库 历史上有一批黄底黑字的 PDF 文档.这批文档都具有相同的问题:没有嵌入字库.在一些设备上阅读时显示乱码.复制文本出来后变成乱码(或复制出来的文本后面多了一个空格). PDF补丁丁可修复上述问题. 只需要在 PDF 文档选项的“文档杂项”中选中“嵌入汉字库”复选框,然后执行补丁,程序就可以帮你解决上述烦恼. 替换文档字库 PDF补丁丁还可以将现有 PDF 文档中使用的字库换成计算机上安装的其它字库,例如原始文本…
生成自己的Webapi帮助文档(一) 最近Webapi接口的开发刚刚进入尾声,随之而来的是让用户知道接口的详细参数信息,看过淘宝的接口文档,但网上没找到他的实现方式 虽然新建Webapi时C#也会给你一个帮助文档的Area,但是总觉得有些太复杂了,实用性值得商榷,于是对他做了些阉割,就有了自己的一个版本. 今天只完成了一些基本框架,具体细节有待进一步实现. 总体思路如下: 1:扩展HttpConfiguration的属性来加入自己的帮助文档生成器, 2:在每个Controller中添加该Cont…
概述 页眉页脚是一篇完整.精致的文档的重要组成部分.在页眉页脚处,可以呈现的内容很多,如公司名称.页码.工作表名.日期.图片,如LOGO.标记等.在之前的文章中介绍了如何通过新建一页空白PDF页来添加页眉到该页面,包括文字页面.图片页眉.但是在实际应用中,该方法会有一定局限性,通过测试,下面将介绍C#给现有的PDF文档添加页眉页脚的方法.该方法中,丰富了我们对于添加页眉页脚的内容形式,包括添加图片.文字.超链接.页码等. 使用工具 Free Spire.PDF for .NET 4.3(社区版)…
最近在做关于PDF文档添加水印的功能,折腾了好久,终于好了.以下做个记录: 首先会用到iTextSharp组件,大家可以去官网下载,同时我也会在本文中附加进来. 代码中添加引用为:   using System; using System.Collections.Generic; using System.Linq; using System.Text; using iTextSharp.text.pdf; using System.IO; using iTextSharp.text;   创建…
页眉.页脚是文档页面顶部或底部重复出现的文本信息.很多用户会习惯在文档页面的顶部与底部区域添加页眉.页脚来展现页码.文档标题.作者姓名.品牌名称等附加信息.而ABBYY FineReader 15(Windows系统)OCR文字识别软件允许用户为PDF文档添加页眉.页脚,即使这些PDF文档是从扫描仪获取的. 用户在ABBYY FineReader 15 OCR文字识别软件使用以下页眉.页脚功能: ·创建页眉/页脚 ·编辑页眉/页脚 ·从列表中删除页眉/页脚 图片1:页眉与页脚 第一.创建页眉/页…
前言 我在以往的文章中曾介绍过如何给Word文档添加文本水印和图片水印,及怎样删除文档中的水印.关于文本水印,之前那篇教程里主要指的是单行字体的水印,而在操作Word文档时,有时也会碰到需要添加多行文字水印的情况.所以,本文将演示如何使用Java程序来为Word文档添加多行文字水印. 代码测试环境: Intellij Idea2019.1 JDK 1.8.0 Spire.Doc.jar Jar包获取及导入 方法一:手动将Jar包导入IDEA.具体步骤如下: 步骤 1:在 E-iceblue中文官…
页眉常用于显示文档的附加信息,我们可以在页眉中插入文本或者图形,例如,页码.日期.公司徽标.文档标题.文件名或作者名等等.那么我们如何以编程的方式添加页眉呢?今天,这篇文章向大家分享如何使用了免费组件Free Spire.PDF给PDF文档添加文本和图片页眉.这个组件提供了一些方法,可以帮助我们快速方便地实现此目的. 添加页眉步骤: 首先,创建一个Visual C#控制台项目,添加组件引用并使用以下命名空间. using System; using System.Drawing; using S…
C# 给Word文档添加内容控件 在MS Word中,我们可以通过内容控件来向word文档中插入预先定义好的模块,指定模块的内容格式(如图片.日期.列表或格式化的文本等),从而创建一个结构化的word文档.下面就来看看如何使用C#给word文档添加组合框.文本.图片.日期选取器及下拉列表等内容控件(这里我借助了一个word组件Spire.Doc). 添加组合框内容控件 组合框用于显示用户可以选择的项目列表.和下拉列表不同的是组合框允许用户编辑或添加项. //给段落添加一个内容控件并指定它的SDT…
前言: 你先得知道HelpPageConfig文件,不知道说明你现在不需要这个,所以下文就不用看了,等知道了再看也不急.当然如果你很知道这个,下文也不用看了,因为你会了. 方法一: new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")) 替换成 new XmlDocumentationProvider("PluginsFolder/*.xm…
使用OpenXml给word文档添加文字,每个模块都有自己对于的属性以及内容,要设置样式就先声明属性对象,将样式Append到属性里面,再将属性append到模块里面,那么模块里面的内容就具备该样式了.此方法默认是在文件后面追加内容 Code: using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Docum…
整理文档时,我们可能会需要在一些或一段文字上添加注释加以说明,那如何以编程的方式实现呢?本文将实例讲述C#中如何使用免费组件给PDF文档添加文本注释,包括自由文本注释.自由文本注释能允许我们自定义它的风格和外观,非常具有实用价值. 首先,下载这个免费版组件Free Spire.PDF.组件下载安装后,Visual Studio创建C#控制台项目,添加bin文件夹的.DLL作为引用以及以下命名空间: using System; using System.Drawing; using System.…
PDF文件的使用频率高了,我们也不只局限于使用PDF文件了,也会需要编辑PDF文件的时候,那么如何在PDF文件中添加和去除贝茨编号呢,应该有很多小伙伴都想知道吧,今天就来跟大家分享一下吧,小伙伴们就一起来看看吧. 操作软件:PDF编辑器http://bianji.xjpdf.com/   1.我们首先来下载并安装一款PDF编辑器,然后打开运行[迅捷PDF编辑器https://www.xunjiepdf.com/editor]并在编辑器中选择打开选项,打开我们要编辑的PDF文件.   2.PDF文…
VS 单文档 添加按钮 今天做项目需要在单文档中创建按钮来响应函数,即点击按钮,调用某函数,特此记录. 1. 在XXXView中添加CButton变量,例如 CButton start; 2. 下来就是 创建按钮 了 ① 在资源 Rescource.h 中注册一下 按钮 #define IDB_BUTTONSTOP(这是名字,自己起)     2000(这是编号,不要和其他的一样就好) ②下来创建按钮 右键 XXXView类->属性->消息->WM_CREAT->add(编辑函数)…
在开发项目的时候,我们有一些场景需要编辑一些HTML文档,作为内容发布系统的一部分,有时候也需要对一些文档如WORD文档进行编辑管理,这样需要我们对这些内容及文档进行合适的管理.本文主要介绍在WInform项目中利用ZetaHtmlEditControl进行HTML内容管理,以及利用TX TextControl控件进行WORD文档管理,这两方面都是我们一般进行内容和文档管理所必须的. 1.内容及文档管理模块功能介绍 整个模块,支持WInform框架和混合式开发框架两种模式,都是基于WInform…
原文标题:Adding images and layout to your Docx4j-generated word documents, part 1 原文链接:http://blog.iprofs.nl/2012/10/22/adding-images-and-layout-to-your-docx4j-generated-word-documents-part-1/ 原文作者:lvdpal 发表日期:2012年10月22日 注:由于我对docx4j也不是很熟悉,所以很多专业名词不会翻译,…
转载请注明出处:http://blog.csdn.net/dongdong9223/article/details/76273859 本文出自[我是干勾鱼的博客] 这里讲一下使用Lucene对doc.docx.pdf.txt文档进行全文检索功能的实现. 涉及到的类一共有两个: LuceneCreateIndex,创建索引: package com.yhd.test.poi; import java.io.BufferedReader; import java.io.File; import ja…
导读:上篇博客中以具体实例分析了HTML和XML在语义上的不同,但是,大家也都发现,XML表现出来的,并没有HTML那样直观或者说美观.其原因是因为XML的表现内容和表现形式被分离.它的表现形式有两种方法可以确定:XSL.CSS.本篇博客,介绍XSL. 一.再现文档 <span style="font-family:KaiTi_GB2312;font-size:18px;"><?xml version="1.0" encoding="UT…
利用递归解析Xml文档添加到TreeView中 private void Form1_Load(object sender, EventArgs e) { XmlDocument doc = new XmlDocument(); doc.Load("School.xml"); var root = doc.DocumentElement as XmlNode; foreach (XmlElement item in root.ChildNodes) { TreeNode node =…
之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文档. 1.下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述. 2.点击红框内的链接,打开api方法的详情页面,如下图所示, 3.点击Test API打开如下页面 4.输入参数,点击S…
在上篇文章中,我对Swagger-UI的基本功能进行了一些介绍,今天在这里介绍一下如何在WebAPI中集成Swagger-UI.这里以一个简单的CRUD的REST服务为例. /// <summary> /// 用户管理 /// </summary> public class UserController : ApiController { static List<User> _users = new List<Controllers.User>(); ; /…
如何建 .netcore webapi 项目这个就不说了,这个都没有没必要看下去. 我这里是.netcore 2.0,虽然没测过1.0的,但想来差不多. 1.Nuget Packages安装,使用程序包管理器控制台,安装命令:Install-Package Swashbuckle.AspNetCore -Pre 或者搜索安装  Swashbuckle.AspNetCore.Swagger 2.生成项目xml文档,多项目的情况下 3.配置Startup.cs.为了直观,我把整个类贴这里了,具体功能…
Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什么选择swagger,现在的网站开发结果越来越注重前后端的分离,比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离.就算再如何的分离实现,也是不可避免的要进行数据交互的,那么接口的重要性就提现出来了.他成了前端和后端交互的重要途径,API文档也因此成了前端开发人员与后端开发人员的重要纽带.…
第一步: 创建web api 在nuget 上搜索 webapitestclient (包含预发行版) 然后在 /Areas/HelpPage/Views/Help/Api.cshtml 末尾 添加 @Html.DisplayForModel("TestClientDialogs")@section Scripts {<link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel…