ASP.NET WebAPI构建API接口服务实战演练

一、课程介绍

一、王小二和他领导的第一次故事 有一天王小二和往常一下去上早班，刚吃完早餐刚一打开电脑没一会儿。王小二的领导宋大宝走到他的面前，我们现在的系统需要提供服务给其他内部业务系统，我看你平时喜欢研究一些技术，所以这次这个任务有你来负责开发，务必保证我们项目组提供的服务好看、好用，最后顺利的完成工作并上线运行。王小二顿到感觉无与伦比的器重和自豪感，于是晚上回家撸起键盘就是一顿baidu+google搜索，最后惊奇地发现了一本叫《ASP.NET WebAPI构建API接口服务实战演练》葵花宝典。于是乎王小二开启了习武之路。 1.1、本葵花宝典手册适合学习人群如下： 1)、完全对ASP.NET WebAPI零基础的童鞋们。 2)、进一步想学习和了解ASP.NET WebAPI技术。 3)、工作中如何快速通过ASP.NET WebAPI构建API接口服务。 4)、阿笨手把手的教会你如何写一手漂亮的WebAPI接口文档。 1.2、本葵花宝典手册课程包含知识点如下： 1)、与Web API的第一次亲密接触，"奇葩"的默认路由配置  2)、 WebApi输出格式有点"丑"，选择XML和JSON哪一个格式？  3)、Web API "奇葩"的参数传递,看着一招就够了。 4)、ASP.NET WebApi标准格式化统一输出响应报文数据 。 5)、ASP.NET WebApi标准格式化统一输出异常报文数据 。 6)、ASP.NET WebApi降龙十八掌之美化JSON时间类型T问题和CORS跨域访问 。 7)、如何用markdown编写一手漂亮的接口文档。 1.3、一言以蔽之修炼完成本葵花宝典手册后达到的境界？ 我们如何优雅使用ASP.NET WebAPI构建API接口服务。 如果您对本次分享课程感兴趣的话，那么请跟踪阿笨一起学习吧。废话不多说，直接上干货，我们不生产干货，我们只是干货的搬运工。

二、手把手教会用ASP.NET WebAPI构建API接口服务

2.1、与Web API的第一次亲密接触，"奇葩"的默认路由配置

王小二刚兴致勃勃打开葵花宝典手册，一上来就遇到404访问不了情况。听说阿笨有解决办法，我去问问题他吧！ ASP.NET Web API路由是整个API的入口。我们访问某个资源就是通过路由映射找到对应资源的URL。通过URL来获取资源的。 对于ASP.NET Web API内部实现来讲，我们的请求最终将定位到一个具体的Action上。所以说，ASP.NET Web API路由就是把客户端请求映射到对应的Action上的过程。

2.2、 WebApi输出格式有点"丑"，选择XML和JSON哪一个格式？

王小二好不容易把404的问题解决了，却遇到了XML和JSON生成出来的有点“丑”的样子，简直就是四不像啊！听说阿笨有解决办法，我去问问题他吧！ 

2.3、Web API "奇葩"的参数传递,看着一招就够了

王小二好不容易把输出格式四不像问题解决了，但是在使用POST多传递几个参数的情况下，就要注意[FromUri] ,[FromBody]带来的限制 ，太复杂了，能不能简单一点。只好问阿笨该如何解决了！听说阿笨有解决办法，我去问问题他吧！ ASP.NET Web API参数传递把握一个思想，不管多么复杂的参数，都采用扁平化来设计。

2.4、ASP.NET WebApi标准格式化统一输出响应报文数据

王小二总算咬牙坚持迈过了上面的那么多“坑”，顿时兴奋不已。刚准备关机睡觉的时候，总感觉心里有事情没解决，顿时坐了起，调用方怎么知道我给的接口数据结果就执行成功和失败了啊。不可能用空字符串来判断吧。听说阿笨有解决办法，我去问问题他吧！    

2.5、ASP.NET WebApi标准格式化统一输出异常报文数据

王小二总算解决了标准格式化统一输出响应报文数据，正兴高采烈的调试第一个接口的时候，却出现了Exception这个程序员恶魔，只好无奈的看着屏幕前一堆红色的错误输出页面。正在焦头烂额的时候，想到了阿笨。听说阿笨有解决办法，我去问问题他吧！    

2.6、ASP.NET WebApi降龙十八掌之美化JSON时间类型T问题和CORS跨域访问

1）、解决json小写问题。 2）、解决json格式化缩进问题。 3）、解决json时间带T的问题。 4)、解决json序列化时的循环引用问题。 5）、解决支持启用跨域访问。

2.7、如何用markdown编写一手漂亮的接口文档

王小二现在已经可以撸一手漂亮的接口了，俗话说:人靠衣装马靠鞍！我们开发的接口是对外给调用方使用的，那么我们如何编写一手漂亮的接口文档，让调用方一看眼前一亮，赏心悦目的感觉咧。 API Manager是一个在线API文档系统；其致力于快速解决团队内部接口文档的编写、维护、存档，和减少团队协作开发的沟通成本。

三、总结

3.1、王小二和他领导的第二次故事

上一次宋大宝交给王小二的任务完成的非常满意，还没来得及当面表扬王小二这个小伙子，却语重心长的说了一番话：随着公司业务量的增长，我们的产品得到了外面商户的一致好评，为了更好的与商户进行业务往来，因此我们公司准备也要弄自己的服务平台。我昨晚思考了一下给你简单的说了一下大概对服务平台的要求：不管客户端是使用PHP、JAVA、C#、移动设备等等语言和设备都能与我们的服务平台进行对接，并且维护和对接成本很低；将来我们需要针对不同的商户进行流量管控，对了最好能过部署在Linux操作系统上，必须将来考虑移植的工作量。王小二我觉得你的能力很不错，小伙子平时交付给你的事情都能够让我满意，所以这个服务平台就有你来主导并开发了，务必按时保质保量完成工作。 王小二倍再一次的感受到了内心的欣慰之情，但是这一次却表情凝重，下班回到家仔细冷静思考了一宿，于是第二个早上班的时候， 总结了以下几点关于服务平台的设计并汇报了宋大宝。 1 )、由于数据不能泄密和篡改，需要保证对外的服务接口可靠性和安全性。 2)、我们提供的服务对开发语言的兼容性强、可扩展性一定要好、最好将来能够跨平台。 从上面的故事，我们可以看的出来宋大宝领导对王小二的器重以及对服务平台的重视！ 预知后事如何,请听下回分解！