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编写一手漂亮的接口文档。

8)、ASP.NET WebApi复杂参数传递使用技巧 。

9)、ASP.NET WebApi 使用Swagger生成接口文档 。

10、ASP.NET WebApi客户端(B/S、C/S)如何调用接口 。

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文档系统;其致力于快速解决团队内部接口文档的编写、维护、存档,和减少团队协作开发的沟通成本。

三、总结


四、ASP.NET WebAPI 高级实战技巧提升篇(补录)

4.1、ASP.NET WebApi复杂参数传递使用技巧
4.2、ASP.NET WebApi 使用Swagger生成接口文档
4.3、ASP.NET WebApi客户端(B/S、C/S)如何调用接口

在线观看
不信的话,扫一扫
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
JS JSP ASP .NET J2AM API接口和返回的版本 目前所有版本的JS JSP ASP .NET J2AM 都是提供源代码的,对于一些脚本语言来说,直接解压缩之后就可以使用了,不需要什么安装步骤。另外一些需要编译的语言,则提供了编译用的 shell 文件(Linux/Unix 下使用)和 bat 文件(Windows 下使用),或者直接提供编译好的二进制库文件。 不过为了让读者能够更清楚如何安装,我们还是对每种语言的安装都做详细的讲解,你可以在安装列表里找到你感兴趣的语言的安装方法。 示例 如果你已经把 JS JSP ASP .NET J2AM 安装好了,那么接下来就让我们开始第一个小程序吧。按照惯例,第一个演示程序几乎总是 HelloWorld,我们也不想打破这个惯例,不过对于 PHPRPC 来说,有服务器端就要有客户端,否则我们就没有什么好演示的啦,所以我们的第一个演示程序实际上是两个,一个是服务器端,另一个是客户端。我们都先用 PHP 语言来写好了。 服务器端 view plaincopy to clipboardprint? <?php include ("php/phprpc_server.php"); function HelloWorld() { return 'Hello World!'; } $server = new PHPRPC_Server(); $server->add('HelloWorld'); $server->start(); ?> 客户端 view plaincopy to clipboardprint? <?php include ("php/phprpc_client.php"); $client = new PHPRPC_Client('http://127.0.0.1/server.php'); echo $client->HelloWorld(); ?> 对于服务器端程序,我们应该将它命名为 server.php(这是因为客户端调用时用的是这个名字,而不是 PHPRPC 的什么规定),然后把它放在本地 Web 服务器的根目录下,并保证服务器可以正常运行 PHP 程序,之后在浏览器或命令行下运行客户端程序,你就可以看到结果了。 这两个程序几乎简单到无需解释的地步,所以如果你已经明白它们的意思,那么就可以直接跳过下面的解释,继续看后面的例子。 服务器端第 1 句是将 它的服务器端程序包含到你的程序里,之后的 2 - 4 句是定义一个远程调用的函数,你会发现它与本地函数没有任何区别。第 5 句是创建服务器端对象,第 6 句是添加要发布的方法,这里添加的就是刚刚定义的 HelloWorld 函数,在 PHP 中,添加的发布方法是函数名的字符串表示,在其它语言中可能略有不同。第 7 句是启动服务。 客户端就更简单了,第 1 句是将 它的客户端程序包含到你的程序里。第 2 句是创建客户端对象,其中的参数就是服务器端的地址。第 3 句是对远程方法(函数)的调用,之后通过 echo 将它显示出来。如果顺利的话,执行后你就会看到输出的 Hello World!。 上面的例子是发布的是函数,下面我们来看一下类中的静态方法如何发布: view plaincopy to clipboardprint? <?php include ("php/phprpc_server.php"); class Hello { static function HelloWorld() { return 'Hello World!'; } } $server = new PHPRPC_Server(); $server->add('HelloWorld', 'Hello'); $server->start(); ?> 这个服务器端只要它的名字与发布的地址与上面那个发布函数的例子一样的话,上面的那个客户端就可以得到同样的结果,也就是说,在客户端看来是没有任何区别的。 它并不是只可以在 PHP 中使用,它同样支持其它语言的服务器和客户端,而且还可以无差别的相互调用。 现在我们来看一下如何在 Java 中调用这个 PHP 的服务器方法: view plaincopy to clipboardprint? import org.phprpc.*; interface IHello { public String helloWorld(); } public class HelloWorld { public static void main ( String [] args ) { PHPRPC_Client client = new PHPRPC_Client("http://127.0.0.1/server.php"); IHello clientProxy = (IHello)client.useService(IHello.class); System.out.println(clientProxy.helloWorld()); } } 当我们把这个例子编译之后,在命令行中输入以下命令就可以看到执行结果了: java -classpath .;phprpc_client.jar HelloWorld 这个 Java 的客户端看上去比 PHP 的要稍微复杂一些,不过仍然很好理解。在 Java 客户端中,我们使用了接口来描述远程方法,之后我们通过 useService 方法返回一个远程代理对象,该对象实现了我们定义的接口,之后我们就可以直接调用远程方法 helloWorld 了。如果你比较细心的话,你还会发现我们在 PHP 中定义的方法和在 Java 中定义的接口的名字的大小写有点不同,但是仍然可以正常调用。是的,PHPRPC 发布的方法是不区分大小写的。所以不论你所使用的语言是否区分大小写,都可以按照自己(或语言)的习惯来定义方法名。 在本章的最后,我们再来看一下在 JavaScript 如何调用它的服务。顺便再强调一下,服务器端不止是可以用 PHP 来编写,你同样可以使用其它语言(比如 Java,.NET,Ruby,Python 等),这里我们只是以 PHP 为例而已。在这个例子中你还会看到如何使用加密传输。 view plaincopy to clipboardprint? <html> <head> <title>HelloWorld</title> [removed][removed] [removed] var client = new PHPRPC_Client('http://127.0.0.1/server.php', ['HelloWorld']); client.setEncryptMode(2); client.HelloWorld(function (result) { alert(result); }); [removed] </head> <body> </body> </html> 这个 JavaScript 是在网页中运行的,这里建议大家要把 head 和 body 标签都写全,即使它们对你来说看上去没有什么用处,但是在有些浏览器中,如果这些标签没有写全,或者写的不正确,程序就不能正确运行。 在这个例子中,我们会发现在创建 PHPRPC_Client 对象时,除了要写服务器地址以外,还要将远程方法的名字作为参数,因为远程方法可能不止一个,所以这个参数是数组类型的。 client.setEncryptMode(2); 这句是设置加密传输,参数 2 表示双向加密,就是参数和结果都加密(只不过这个 HelloWorld 比较特殊,它没有参数)。 接下来就是调用远程方法 HelloWorld 了,我们会发现它跟 PHP 和 Java 客户端的调用不太一样。是的,在 JavaScript 中远程调用都是采用异步方式的,也就是说要获得结果,需要用回调函数,回调函数作为远程方法的最后一个参数,回调函数也有四个参数,这里我们只使用第一个参数,也就是返回结果 result,通过 alert(result); 我们就可以在浏览器中看到最后弹出的 Hello World! 提示框了。 通过上面的例子,我们已经看到在 PHP、Java 和 JavaScript 这三种语言中使用 PHPRPC 都很简单,但因为语言的不同,在写法和用法上又有一些差别。不过你不用担心其它的语言跟它们也会有很大的差别,因为在接下来的章节中你很快就会发现其它语言跟这上面三种语言实现的写法和用法上的相似或相同之处了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值