编辑推荐
如何为浏览器和移动设备等多客户端设计和构建可演化WebAPI?《ASP.NET Web API设计》以ASP.NETWebAPI框架为例,系统介绍了相关的理论和工具,让读者全面掌握设计和实现可演化WebAPI的技术。
《ASP.NETWebAPI设计》主要面向有经验的.NET开发人员。不过,书中关于WebAPI基础理论和设计的内容同样适用于Java、Ruby、PHP和Node等开发者。内容简介
《ASP.NETWebAPI设计》依托ASP.NETWebAPI阐述API设计与开发的通用技术,是一本全面介绍如何构建真实可演化API的实践指南。《ASP.NET Web API设计》共分三部分。第一部分介绍Web/HTTP和API开发的基础知识,介绍ASP.NETWebAPI,为初学者以及想充分利用HTTP的读者建立好的起点。第二部分完整介绍了真实Web应用程序的开发,其内容从设计讲到实现,全面覆盖客户端与服务器端开发。第三部分深入ASP.NETWebAPI的内部机制,并讲解一些高级的主题(如安全和可测试性),加深你的理解,让读者学会更好地利用WebAPI构建可演化系统。作者简介
GlennBlock,曾任职微软,推动了ASP.NETWebAPI早期版本的开发。
PabloCibraro,拥有十余年使用微软技术设计和实现大型分布式系统的经验。
PedroFélix,是一位软件工程师和教授,研究方向为基础设施实现、用户身份管理,以及访问控制。
HowardDierking,是微软ASP.NETWebAPI团队的产品经理,当前的工作重点包括NuGet和Katana项目。
DarrelMiller,是Tavis软件公司的创始人之一,帮助人们学习如何在业务应用中采用REST架构风格。
精彩书评
★“这《ASP.NET Web API设计》提供了及时而全面的指南,帮助人们使用ASP.NETWebAPI构建坚实的系统,融合了ASP.NETWebAPI团队的经验与软件业界多年的专业积累。”
——ScottGuthrie微软“云和企业”副总裁
★“第1次获悉《ASP.NET Web API设计》时,我就急切地想读,原因有二。首先,我当前的工作中涉及为应用设计API以使之与多种系统交互。其次,是因为《ASP.NET Web API设计》的一位作者——GlennBlock,我认识他有段时间了,我见过他,与他有过对话,读了他的大量博文,我确定《ASP.NET Web API设计》不会让人失望,而事实证明确实如此。”
——JosephGuadagno亚利桑那SoutheastValley.NET用户组创始人目录
作者简介
关于封面图
序
前言
第一部分 基础知识
第1章 因特网、万维网和HTTP协议
1.1 Web体系结构
1.1.1 资源
1.1.2 URI
1.1.3 酷URI
1.1.4 表示
1.1.5 媒体类型
1.2 HTTP协议
1.2.1 HTTP1.1之后
1.2.2 HTTP消息交换
1.2.3 中间层
1.2.4 中间层类型
1.2.5 HTTP方法
1.2.6 标头
1.2.7 HTTP状态码
1.2.8 内容协商
1.2.9 缓存
1.2.10 身份验证
1.2.11 身份验证方案
1.2.12 附加身份验证方案
1.3 小结
第2章 WebAPI
2.1 什么是WebAPI
2.2 SOAPWeb服务
2.3 WebAPI的起源
2.4 WebAPI革命开始
2.5 关注Web
2.6 WebAPI指南
2.7 特定领域的媒体类型
2.8 媒体类型档案
2.9 多个表示
2.10 API风格
2.10.1 Richardson成熟度模型
2.10.2 RPC(RMM第0级)
2.10.3 资源(RMM第1级)
2.10.4 HTTP谓词(RMM第2级)
2.10.5 以资源为中心的API
2.10.6 超媒体(RMM第3级)
2.10.7 REST
2.10.8 REST约束
2.11 小结
第3章 ASP.NETWebAPI101
3.1 核心场景
3.1.1 第一类HTTP编程
3.1.2 对称的客户端和服务器编程体验
3.1.3 对不同格式的灵活支持
3.1.4 告别"尖括号编码"
3.1.5 支持单元测试
3.1.6 多种托管选项
3.2 ASP.NETWebAPI入门
3.3 新建WebAPI项目
3.3.1 WebApiConfig
3.3.2 ValuesController
3.4"HelloWebAPI!"
3.4.1 创建服务
3.4.2 客户端
3.4.3 宿主
3.5 小结
第4章 处理架构
4.1 托管层
4.2 消息处理程序管道
4.3 控制器处理
4.4 小结
第二部分 真实世界的API开发
第5章 应用程序
5.1 为什么要可演化
5.1.1 演化的障碍
5.1.2 代价是什么
5.1.3 为什么不创建新版本
5.1.4 付诸实践
5.2 应用程序目标
5.2.1 目标
5.2.2 机会
5.3 信息模型
5.3.1 子域
5.3.2 相关资源
5.3.3 属性组
5.3.4 属性组的集合
5.3.5 信息模型与媒体类型
5.3.6 问题集合
5.4 资源模型
5.4.1 根资源
5.4.2 搜索资源
5.4.3 集合资源
5.4.4 个体资源
5.5 小结
第6章 媒体类型选择与设计
6.1 自描述
6.2 协议类型
6.3 媒体类型
6.3.1 原始格式
6.3.2 流行格式
6.3.3 新格式
6.3.4 超媒体类型
6.3.5 媒体类型爆炸
6.3.6 通用媒体类型和档案
6.3.7 其他超媒体类型
6.4 链接关系类型
6.4.1 语义
6.4.2 替换嵌入资源
6.4.3 间接层
6.4.4 引用数据
6.4.5 工作流
6.4.6 语法
6.4.7 完美结合
6.5 设计新的媒体类型协议
6.5.1 选择格式
6.5.2 支持超媒体
6.5.3 可选、强制、省略和适用
6.5.4 嵌入元数据和外部元数据
6.5.5 可扩展性
6.5.6 注册媒体类型
6.6 设计新的链接关系
6.6.1 标准链接关系
6.6.2 扩展链接关系
6.6.3 嵌入链接关系
6.6.4 注册链接关系
6.7 问题跟踪域中的媒体类型
6.7.1 list资源
6.7.2 item资源
6.7.3 discovery资源
6.7.4 search资源
6.8 小结
第7章 构建API
7.1 设计
7.2 获得源代码
7.3 使用行为驱动开发构建实现
7.4 浏览解决方案
7.5 软件包和程序库
7.6 自托管
7.7 模型和服务
7.7.1 问题和问题库
7.7.2 IssueState
7.7.3 IssuesState
7.7.4 Link
7.7.5 LinkeStateFactory
7.7.6 LinkFactory
7.7.7 IssueLinkFactory
7.8 验收标准
7.9 功能:获取问题
7.9.1 获取一个问题
7.9.2 获取未关闭的和已关闭的问题
7.9.3 获取不存在的问题
7.9.4 获取所有问题
7.9.5 获取所有问题的Collection+Json表示
7.9.6 搜索问题
7.10 功能:创建问题
7.11 功能:更新问题
7.11.1 更新一个问题
7.11.2 更新不存在的问题
7.12 功能:删除问题
7.12.1 删除一个问题
7.12.2 删除不存在的问题
7.13 功能:处理问题
7.13.1 测试
7.13.2 实现
7.14 小结
第8章 改进API
8.1 新功能的验收标准
8.2 实现输出缓存支持
8.3 添加输出缓存测试
8.4 实现缓存重验证
8.5 为缓存重验证实现条件GET
8.6 冲突检测
8.7 实现冲突检测
8.8 变更审计
8.9 使用Hawk认证实现变更审计
8.10 跟踪
8.11 实现跟踪
8.12 小结
第9章 构建客户端
9.1 客户端程序库
9.1.1 封装库
9.1.2 链接用作函数
9.2 应用程序工作流
9.2.1 用户需知
9.2.2 带有使命的客户端
9.2.3 客户端状态
9.3 小结
第三部分 WebAPI细节
第10章 HTTP编程模型
10.1 消息
10.2 标头
10.3 消息内容
10.3.1 使用消息内容
10.3.2 创建消息内容
10.4 小结
第11章 托管
11.1 Web托管
11.1.1 ASP.NET基础结构
11.1.2 ASP.NET路由
11.1.3 WebAPI路由
11.1.4 全局配置
11.1.5 WebAPIASP.NET处理程序
11.2 自托管
11.2.1 WCF架构
11.2.2 HttpSelfHostServer类
11.2.3 HttpSelfHostConfiguration类
11.2.4 URL预留和访问控制
11.3 用OWIN和Katana托管WebAPI
11.3.1 OWIN
11.3.2 Katana项目
11.3.3 WebAPI配置
11.3.4 WebAPI中间件
11.3.5 OWIN生态环境
11.4 内存托管
11.5 AzureServiceBusHost
11.6 小结
第12章 控制器和路由
12.1 HTTP消息流概览
12.2 消息处理程序管道
12.2.1 分发程序
12.2.2 HttpControllerDispatcher
12.2.3 控制器选择
12.2.4 控制器激活
12.3 控制器管道
12.3.1 ApiController
12.3.2 ApiController处理模型
12.4 小结
第13章 格式化程序和模型绑定
13.1 ASP.NETWebAPI中模型的重要性
13.2 模型绑定如何工作
13.3 内建的模型绑定器
13.3.1 ModelBindingParameterBinder
13.3.2 值提供程序
13.3.3 模型绑定器
13.3.4 只对URI进行模型绑定
13.3.5 FormatterParameterBinder实现
13.3.6 HttpParameterBinding的默认选择
13.4 模型验证
13.4.1 将数据标记属性用于模型
13.4.2 查询验证结果
13.5 小结
第14章 HttpClient
14.1 HttpClient类
14.1.1 生存周期
14.1.2 封装类
14.1.3 多个实例
14.1.4 线程安全
14.1.5 辅助方法
14.1.6 抽丝剥茧
14.1.7 完成的请求无异常
14.1.8 内容为王
14.1.9 取消请求
14.1.10 SendAsync
14.2 客户端消息处理程序
14.2.1 代理处理程序
14.2.2 伪响应处理程序
14.2.3 创建可以重用的响应处理程序
14.3 小结
第15章 安全
15.1 传输安全
15.2 在ASP.NETWebAPI中使用TLS
15.2.1 IIS托管时使用TLS
15.2.2 自托管时使用TLS
15.3 身份验证
15.3.1 声明模型
15.3.2 获取和设置当前用户对象
15.3.3 基于传输的身份验证
15.3.4 服务器身份验证
15.3.5 客户端身份验证
15.3.6 HTTP身份验证框架
15.3.7 实现基于HTTP的身份验证
15.3.8 Katana身份验证中间件
15.3.9 主动和被动的身份验证中间件
15.3.10 WebAPI身份验证筛选器
15.3.11 基于令牌的身份验证
15.3.12 Hawk身份验证方案
15.4 授权
15.4.1 授权执行
15.4.2 跨域资源共享
15.4.3 ASP.NETWebAPI的CORS支持
15.5 小结
第16章 OAuth2.0授权框架
16.1 客户端应用程序
16.2 访问受保护资源
16.3 获得访问令牌
16.4 授权码授予
16.5 范围
16.6 前通道与后通道
16.7 刷新令牌
16.8 资源服务器和授权服务器
16.9 在ASP.NETWebAPI中处理访问令牌
16.10 OAuth2.0与身份验证
16.11 基于范围的授权
16.12 小结
第17章 可测试性
17.1 单元测试
17.1.1 使用测试框架
17.1.2 VisualStudio单元测试入门
17.1.3 xUnit.NET
17.1.4 单元测试在测试驱动开发中的作用
17.2 对ASP.NETWebAPI实现进行单元测试
17.2.1 测试ApiController
17.2.2 测试MediaTypeFormmater
17.2.3 单元测试HttpMessageHandler
17.2.4 测试ActionFilterAttribute
17.3 对路由进行单元测试
17.4 ASP.NETWebAPI的集成测试
17.5 小结
附录A 媒体类型
附录B HTTP标头
附录C 内容协商
附录D 缓存实战
附录E 身份验证工作流
附录F application/issue+json媒体类型规范
附录G 公钥加密和证书
前言/序言
为什么要阅读《ASP.NET Web API设计》
WebAPI开发呈现爆炸式增长。各家公司都在投资构建可以通过Web使用多种客户端访问的系统。想想你经常光顾的网站,这些网站很可能已经提供了访问API。创建一个使用HTTP进行通信的API非常简单,而挑战在第一个版本部署后才会出现。实际上,HTTP协议的制定者对这个问题,以及如何设计可演化API已经进行了周详的考虑。媒体类型和超媒体就是设计可演化API的核心。但是,很多API开发者并未对此加以考虑或利用,部署的API没有合理地使用HTTP协议,客户端严重依赖API的具体实现。这样的API很难进行演化,极易破坏客户端功能。为什么会出现这样的情况呢?因为人们经常觉得,从工程角度看,这是实现功能的最简单、最直接的做法。但是,从长期看,这种做法违反直觉,与Web自身的基本设计原则背道而驰。
《ASP.NET Web API设计》的目标读者是希望设计出适应长期变化的API的开发者。变化是不可避免的:你今天构建的API将会演化。因此,问题不是"要不要",而是"如何"设计可演化的API。你在项目早期做出的决定(或者未做出的决定)会极大地影响以下问题的答案。
添加一个新功能,会破坏现有的客户端,强制现有客户端升级并重新部署吗?或者,现有客户端还能继续工作?
如何保障API的安全?能够使用较新的安全协议吗?
API可以扩展规模,满足用户需求吗?或者必须重新进行架构设计?
能够支持未来出现的新客户端和新设备吗?
你在设计时可以考虑这些问题。初看起来,这似乎是预先做大量设计(BigDesignUpFront)或者瀑布方法。其实不然。你不需要在构建系统前做出完备的设计,也不需要进行过度分析。有些决定的确需要预先做出,但这些决定处于较高的层次,关系到整体设计。要做出这些决定,你并不需要理解或预知系统的每个方面。实际上,这些决定奠定了迭代演化的基础,在随后构建系统时,你可以在此基础上,采取各种方式不断强化自己的目标。
《ASP.NET Web API设计》更偏重应用而非理论。我们希望你读完《ASP.NET Web API设计》之后,获得构建真实可演化系统的能力。为了达到这个目的,开篇将介绍Web和WebAPI开发的一些必知内容,然后从设计到实现,逐步介绍如何使用ASP.NETWebAPI创建一个新API。这个API的实现将覆盖一些重要的主题,例如:如何使用ASP.NETWebAPI实现超媒体、如何执行内容协商。我们将演示这个API在部署后如何实际进行演化,还将讨论如何使用既有实践(例如:验收测试、测试驱动开发)和技术(例如:控制反转)提高代码的可维护性。最后,我们将深入WebAPI的内部,帮助你加深理解,更好地利用WebAPI构建可演化系统。
预备知识
要充分理解《ASP.NET Web API设计》的内容,你应该是一位开发人员,拥有使用.NET3.5或更高版本开发C#应用程序的经验。如果你还具有构建WebAPI的经验,那就更好了。在开发API时使用过哪种框架并不重要,重要的是应该熟悉相关的概念。阅读《ASP.NET Web API设计》并不需要ASP.NETWebAPI或ASP.NET经验,但熟悉ASP.NETMVC的确会对你很有帮助。
如果你不是一位.NET开发人员,那么《ASP.NET Web API设计》也有适合阅读的内容。我们编写《ASP.NET Web API设计》时设定了一个具体的目标,要使书中大部分内容关注API设计和开发的通用技术,不与ASP.NETWebAPI直接相关。因此,我们认为,无论你的开发背景是什么(Java、Ruby、PHP、Node等),都可以通过《ASP.NET Web API设计》前两部分的大部分内容学习API的开发。
漫游指南
在开始你的阅读旅程之前,这里有一些漫游《ASP.NET Web API设计》内容的指南。
第一部分主要对WebAPI开发进行介绍。这部分覆盖了Web/HTTP和API开发的基础知识,介绍ASP.NETWebAPI。如果你刚刚接触WebAPI开发/ASP.NETWebAPI,那么这部分是一个很好的开始。如果你已经在使用ASP.NETWebAPI(或其他WebAPI框架),但是想更多地了解如何充分利用HTTP,这部分也是一个很好的起点。
第二部分关注真实世界的WebAPI开发。这部分完整介绍了一个真实世界中Web应用程序的开发,从设计到实现,覆盖客户端和服务器。如果你已经对WebAPI开发颇为熟悉,希望很快开始构建应用程序,那么可以直接从第二部分开始阅读。
第三部分是一个相当全面的参考资料,详细介绍了ASP.NETWebAPI各部分的内部机制。这部分还覆盖了一些较为高级的主题,例如:安全和可测试性。如果你已经在使用ASP.NETWebAPI构建应用程序,希望了解如何将WebAPI自身的功能发挥到极致,请从第三部分开始阅读。