C# RESTful API 访问辅助类

REST 全称是 Representational State Transfer,有人说它是一种风格,并非一种标准,个人觉得挺有道理。它本身并没有创造新的技术、组件与服务,更像是告诉大家如何更好地使用现有Web标准中的一些准则和约束,也不可否认,RESTFul 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。

RESTful 风格的 API,在 HTTP 协议上使用的是标准 HTTP 方法,GET、PUT、POST 和 DELETE 等。

常用实践

(1)API 返回结果通常为 JSON 形式,请求的头部属性 Accept 通常设置为 application/json

(2)请求的 Body 数据部分使用 JSON 形式

(3)鉴权信息使用 JWT 等形式的授权码方式,放在请求头部属性中传输,属性名称自定义,如 auth,token 等等

辅助类设计

(1)属性定义

定义属性:TokenHeaderName

上述实践描述中,自定义部分为鉴权信息在头部属性中的名称,定义该属性表示这个名称。

定义属性:DefaultToken

考虑到鉴权信息在某些场景下可初始为一个固定值,定义该属性在默认情况下使用。

具体定义如下:

// 鉴权 token 的请求头属性名称publicStringTokenHeaderName {get;set; }// 默认的鉴权 token 信息publicStringDefaultToken {get;set; }

(2)方法定义

方法定义跟标准的 HTTP 方法一致,这里定义常用的 Get、Put、Post、Delete 方法。

再抽取其中会重复的部分形成一些私有方法来复用,再重载一些方法使得可以应用默认参数值。

(2.1)构造方法

构造时可以指定鉴权头部属性名和 token,也可以不指定。

publicRestApiVisitHelper(){

}// 构造时设置鉴权 token 的请求头属性名称publicRestApiVisitHelper(StringtokenHeaderName){

    TokenHeaderName = tokenHeaderName;

}// 构造时设置鉴权 token 的请求头属性名称,以及默认的 token 值publicRestApiVisitHelper(StringtokenHeaderName,StringdefaultToken){

    TokenHeaderName = tokenHeaderName;

    DefaultToken = defaultToken;

}

(2.2)访问所需辅助方法

(2.2.1) 创建 WebClient,设置好相关属性,包括鉴权头部信息

// 创建 WebClient 并设置好 token 信息private WebClient CreateWebClient(Stringtoken){    System.Net.ServicePointManager.ServerCertificateValidationCallback =((sender, certificate, chain, sslPolicyErrors) =>true);    System.Net.WebClient webClientObj =newSystem.Net.WebClient();    webClientObj.Headers.Add("Accept","application/json");if(!String.IsNullOrEmpty(TokenHeaderName) && !String.IsNullOrEmpty(token))    {        webClientObj.Headers.Add(TokenHeaderName, token);    }    webClientObj.Encoding = Encoding.UTF8;returnwebClientObj;}

(2.2.2)将查询参数格式化拼接成最终 url

// 将查询参数格式化拼接到 url 上形成最终的访问地址privateStringFormatUrl(StringapiUrl, Hashtable queryParams){StringqueryString ="";    foreach (varkinqueryParams.Keys)    {if(!String.IsNullOrEmpty(queryString))        {            queryString +="&";        }        queryString +=String.Format("{0}={1}", k, queryParams[k]);    }if(!String.IsNullOrEmpty(queryString))    {        apiUrl +="?"+ queryString;    }returnapiUrl;}

(2.2.3)异常统一处理

出现请求异常时,可以统一进行处理,具体返回结果可自行定义。

// 异常时返回的信息:应该根据实际需要进行返回privateStringWhenError(Exception e){    JObject result =newJObject();    result["err_code"] =-1;if(eisWebException)    {varwe = (WebException)e;if(we.Response !=null)// 如果有输出则仍然返回实际输出{returnnewStreamReader(we.Response.GetResponseStream()).ReadToEnd();        }else{                                result["err_msg"] = we.Message;        }    }else{        result["err_msg"] = e.Message;    }returnresult.ToString(Newtonsoft.Json.Formatting.None);}

(2.3)公开方法具体实现

有了以上辅助方法,实现代码会变得简洁,且各个方法代码结构类似。以下以 Post 方法(包括重载) 为例展示基本实现。

///<summary>///Post Api 返回结果文本,使用默认的鉴权 token///</summary>///<param name="apiUrl"></param>///<param name="queryParams"></param>///<param name="body"></param>///<returns></returns>publicStringPost(stringapiUrl, Hashtable queryParams, JObject body){returnPost(apiUrl, queryParams, body, DefaultToken);}///<summary>///Post Api 返回结果文本///</summary>///<param name="apiUrl"></param>///<param name="queryParams"></param>///<param name="body"></param>///<param name="token"></param>///<returns></returns>publicStringPost(stringapiUrl, Hashtable queryParams, JObject body, String token){    System.Net.WebClient webClientObj = CreateWebClient(token);    apiUrl = FormatUrl(apiUrl, queryParams);try{        String result = webClientObj.UploadString(apiUrl,"POST", body.ToString(Newtonsoft.Json.Formatting.None));returnresult;    }catch(Exception ce)    {returnWhenError(ce);    }}

完整源码

https://github.com/triplestudio/helloworld/blob/master/RestApiVisitHelper.cs

如果有想学习编程的初学者,可来我们的C/C++技术学习扣qun的哦:58,934,83-89里面免费送整套系统的C/C++教程!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容