WebAPI客户端
封装WebAPI客户端,附赠Nuget打包上传VS拓展工具
一、前言
上篇《 WebAPI使用多个xml文件生成帮助文档 》有提到为什么会出现基于多个xml文件生成帮助文档的解决方案,因为定义的模型可能的用处有:
1:单元测试
2:其他项目引用(可能以Nuget包的形式)
3:WebAPI客户端(封装的HttpClient及WebAPI接口调用,其实包含在第2点内..)
要源码的可以直接拉到最下面,源码一如既往的还在那。
二、为什么要封装WebAPI客户端
1:让WebAPI对于调用者来说“透明”,直接以引用程序集的方式。
2:统一项目内调用入口(当然了,非要绕过直接去请求接口肯定也是可以得,但是这是团队管理的问题)。
3:组合接口调用
4:版本化(通过Nuget,不论是自建还是Nuget.org)
三、封装的WebAPI客户端都包含些什么
这里继续使用 WebAPI2PostMan 项目来演示。
首先,因为将WebAPI的接口以HttpClient来进行封装,那至少需要定义出接口的请求路由,此处仅定义出了两处。
我们在解决方案新建一个类库项目,并将其命名为 WebAPI2PostMan.Client ,接着添加一个名为 WebApi2PostManStatic 的类
- using System.Configuration;
- namespace WebAPI2PostMan.Client
- {
- /// <summary>
- /// WebApi2PostMan静态资源类
- /// </summary>
- public class WebApi2PostManStatic
- {
- /// <summary>
- /// 服务地址
- /// </summary>
- public static string ServiceUrl = ConfigurationManager.AppSettings["WebAPI2PostManServiceUrl"];
- /// <summary>
- /// 获取所有产品
- /// </summary>
- public static string RouteProductGetAll = "api/Product/All";
- /// <summary>
- /// 添加产品
- /// </summary>
- public static string RouteProductAdd = "api/Product/Add";
- }
- }
接口请求无非就是Http的那几个方法,但此处仅认为我们的接口只包含Get和Post两种Http请求方法。
基于此,我们定义出一个WebApiHelper类。
- /// <summary>
- /// WebAPI帮助类
- /// </summary>
- public class WebApiHelper
- {
- public static T1 CallPostWebApi<T1, T2>(string url, T2 request, string serviceUrl, int? timeOut = 10)
- public static T1 CallGetWebApi<T1>(string url, string serviceUrl, int? timeOut = 10)
- public static List<TResponse> CallWebApiBatch<TRequest, TResponse>(HttpMethod method, string endpoint, List<TRequest> batchRequestModels, string url, string serviceUrl, int? timeOut = 10)
- public static async Task<T1> CallPostWebApiAsync<T1, T2>(string url, T2 request, string serviceUrl, int? timeOut = 10)
- public static async Task<T1> CallGetWebApiAsync<T1>(string url, string serviceUrl, int? timeOut = 10)
- public static async Task<List<TResponse>> CallWebApiBatchAsync<TRequest, TResponse>(HttpMethod method,string endpoint,List<TRequest> batchRequestModels,string url,string serviceUrl,int? timeOut=10)
- }
为了节省篇幅和便于观看,将实现都删去了,可以看到定义了6个方法,分为同步和异步一共三类,Get , Post ,Batch(批量接口,有感兴趣的就下篇讲讲)。
然后,再添加一个用于封装的类 WebApi2PostManClient。
- using System.Collections.Generic;
- using WebAPI2PostMan.WebModel;
- namespace WebAPI2PostMan.Client
- {
- /// <summary>
- /// WebApi2PostMan 客户端
- /// </summary>
- public class WebApi2PostManClient
- {
- /// <summary>
- /// 获取所有产品
- /// </summary>
- /// <param name="timeout">超时时间</param>
- /// <returns>产品列表</returns>
- public static IEnumerable<Product> GetAllProduct(int? timeout = 10)
- {
- return WebApiHelper.CallGetWebApi<IEnumerable<Product>>(WebApi2PostManStatic.RouteProductGetAll,WebApi2PostManStatic.ServiceUrl,timeout);
- }
- /// <summary>
- /// 添加产品
- /// </summary>
- /// <param name="request">添加的产品</param>
- /// <param name="timeout">超时时间</param>
- /// <returns>添加结果</returns>
- public static string AddProduct(Product request,int? timeout = 10)
- {
- return WebApiHelper.CallPostWebApi<string, Product>(WebApi2PostManStatic.RouteProductAdd, request,WebApi2PostManStatic.ServiceUrl, timeout);
- }
- }
- }
四、使用Nuget包管理器来发布WebAPI2PostMan.Client
怎么搭建NugetServer就不赘述了,新建一个空的web项目接着程序包控制台输入
- PM> Install-Package NuGet.Server
然后该有的都会有了,直接发布到IIS即可。
此时,本地已经有一个NugetServer了,浏览如下。
右键项目 WebAPI2PostMan.Client => 属性 => 应用程序 => 程序集信息,补全一些信息。
运行命令行并定位到当前项目目录,执行
- nuget pack WebAPI2PostMan.Client.csproj -s http://localhost:88 123
此处的nuget是配的环境变量,也可以替换成( 路径/NuGet.exe ),若启用了 NuGet 程序包还原的话,解决方案目录下的文件夹.nuget内会有NuGet.exe及其配置。
http://localhost:88 即为server地址,此处切不可加/nuget,否则会报403. 后面是密码,默认没设置的话会有警告并提示使用nuget setApiKey 设置。
那么其实一直以来都是做一个批处理脚本来打包并上传我们的包。
或者是dudu很久以前发的《用Nuget管理好自家的包包i》以及 http://www.cnblogs.com/lzrabbit/tag/NuGet/ 讲的都很详细。
还有《将nuget与VS直接集成,实现一键上传等功能》,只不过是需要手动设置的。
为了不想这么麻烦,顺手写了一个VS的拓展工具 Push2NuGet 来简化这些操作。
首先在 工具=》拓展和更新=》联机=》Visual Studio库 =》输入 Push2NuGet 安装,重启解决方案。
因为是一口气写出来的,没想好 一些服务参数放哪,就暂时扔到.nuget文件夹下,因此,需要在.nuget文件夹下 新建一个NuGet.xml的文件并完善信息。
- <?xml version="1.0" encoding="utf-8"?>
- <SelfServer>
- <Url>http://localhost:88</Url>
- <ApiKey>123</ApiKey>
- </SelfServer>
然后右键项目点击【打包并上传】即可。
成功后显示。
新建一个 单元测试项目 WebAPI2PostMan.Tests 并在Nuget里设置Nuget源。
安装刚才上传的 WebAPI2PostMan.Client
添加两个单元测试方法
五、源码
示例源码:https://github.com/yanghongjie/WebAPI2PostMan
拓展工具:https://github.com/yanghongjie/Push2NugetServer
既然都看到这了,顺手评价再赏个推荐呗!
WebAPI客户端的更多相关文章
- 封装WebAPI客户端,附赠Nuget打包上传VS拓展工具
一.前言 上篇< WebAPI使用多个xml文件生成帮助文档 >有提到为什么会出现基于多个xml文件生成帮助文档的解决方案,因为定义的模型可能的用处有: 1:单元测试 2:其他项目引用(可 ...
- 一种类似Retrofit声明接口即可实现调用的WebApi客户端框架
为.Net出力 java有okhttp,还在okhttp这上搞了一个retrofit,.net有HttpClient,但目前我没有发现有类似的retrofit框架.最近在搞mqtt的webApi封装, ...
- (3)WebApi客户端调用
1.创建一个应用台控制程序,可以把Model的引用,用下面的方法拖拽上来(解决方案里没有这个文件,只是这个文件的引用) 2.Program.cs using System; using System ...
- WebApi用JilFormatter处理客户端序列化的字符串加密,之后在服务端解析。
本文有改动,参考原文:https://www.cnblogs.com/liek/p/4888201.html https://www.cnblogs.com/tonykan/p/3963875.htm ...
- WebAPI使用多个xml文件生成帮助文档
一.前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xm ...
- WebAPI使用多个xml文件生成帮助文档(转)
http://www.cnblogs.com/idoudou/p/xmldocumentation-for-web-api-include-documentation-from-beyond-the- ...
- 【转】WebAPI使用多个xml文件生成帮助文档
来自:http://www.it165.net/pro/html/201505/42504.html 一.前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet ...
- webapi跨域实现(CROS、JSONP)
CROS: /// <summary> /// 支持WebAPI服务器端跨域 /// </summary> public class ServerCrossDomainAttr ...
- 我的“第一次”,就这样没了:DDD(领域驱动设计)理论结合实践
写在前面 插一句:本人超爱落网-<平凡的世界>这一期,分享给大家. 阅读目录: 关于DDD 前期分析 框架搭建 代码实现 开源-发布 后记 第一次听你,清风吹送,田野短笛:第一次看你,半弯 ...
随机推荐
- enumerateObjectsUsingBlock、enumerateObjectsWithOptions、enumerateObjectsAtIndexes、makeObjectsPerfor使用
OC至 NSArray它提供了一个方便的遍历block,以下具体说明 第一.enumerateObjectsUsingBlock NSArray *array=@[@"aa",@& ...
- Android - 设置ImageView为全屏显示
设置ImageView为全屏显示 本文地址: http://blog.csdn.net/caroline_wendy ImageView默认会适应屏幕大小, 假设想使用全屏填充, 则须要使用: and ...
- C++11:强类型枚举(enum)
// C++11之前的enum类型是继承C的,不温不火: // C++11对enum动刀了,加强了类型检查,推出强类型enum类型,眼前一亮 // 使用过QT 的都知道,早就应该这么做了,用的非常爽! ...
- 单链表的实现---SingleLinkedList
单链表的实现,定义为SingleLinkedList class Node<AnyType>{ //结点Node类 public AnyType data; public Node< ...
- HDU 4433 locker 2012 Asia Tianjin Regional Contest 减少国家DP
意甲冠军:给定的长度可达1000数的顺序,图像password像锁.可以上下滑动,同时会0-9周期. 每个操作.最多三个数字连续操作.现在给出的起始序列和靶序列,获得操作的最小数量,从起始序列与靶序列 ...
- Highcharts中文教程
http://www.hcharts.cn/docs/index.php?doc=start
- 产品CEO?别傻了,你不是拿破仑
编者按:本文出自技术产品经理Daniel Elizalde的博客,中文版由天地会珠海分舵进行编译. 全文针对如今流行的把产品经理比喻成"产品CEO"的这一说法进行深入的分析.跟大家 ...
- XML数据读取方式性能比较(一)
原文:XML数据读取方式性能比较(一) 几个月来,疑被SOA,一直在和XML操作打交道,SQL差不多又忘光了.现在已经知道,至少有四种常用人XML数据操作方式(好像Java差不多),不过还没有实际比较 ...
- index_ss hint 使用的运行计划变化对照
index_ss hint 使用的运行计划变化对照 当中 buffer 代表:当前操作中发生的内存读次数,包括一致性读和当前读 尽管 emp 表记录数不多,可是buffer 读内存的次数区别还是有点 ...
- 对SA权限的再突破 (对付xplog70.dll被删)转载
原文:对SA权限的再突破 (对付xplog70.dll被删)转载 对SA权限的再突破 (对付xplog70.dll被删)转载 转载自:http://www.bitscn.com/plus/view.p ...