Web API的设计与开发PDF|Epub|txt|kindle电子书版本网盘下载

Web API的设计与开发PDF格式电子书版下载

注意：本站所有压缩包均有解压码： 点击下载压缩包解压工具

第1章 什么是Web API1

1.1 Web API的重要性3

1.1.1 通过API才能使用的在线服务出现5

1.1.2 移动应用与API7

1.1.3 API的经济学7

1.2 各种各样的API模式8

1.2.1 将已发布的Web在线服务的数据或功能通过API公开8

1.2.2 将附加在其他网页上的微件公开9

1.2.3 构建现代Web应用10

1.2.4 开发智能手机应用11

1.2.5 开发社交游戏11

1.2.6 公司内部多个系统的集成12

1.3 应该通过API公开什么12

1.3.1 公开API是否会带来风险13

1.3.2 公开API能得到什么14

1.4 设计优美的Web API的重要性15

1.4.1 设计优美的Web API易于使用15

1.4.2 设计优美的Web API便于更改16

1.4.3 设计优美的Web API健壮性好16

1.4.4 设计优美的Web API不怕公之于众16

1.5 如何美化Web API17

1.6 REST与Web API18

1.7 作为目标对象的开发人员数量与API的设计思想19

1.8 小结20

第2章 端点的设计与请求的形式21

2.1 设计通过API公开的功能21

2.2 API端点的设计思想24

2.3 HTTP方法和端点31

2.3.1 GET方法32

2.3.2 POST方法33

2.3.3 PUT方法33

2.3.4 DELETE方法34

2.3.5 PATCH方法35

2.4 API端点的设计37

2.4.1 访问资源的端点设计的注意事项41

2.4.2 注意所用的单词43

2.4.3 不使用空格及需要编码的字符43

2.4.4 使用连接符来连接多个单词44

2.5 搜索与查询参数的设计45

2.5.1 获取数据量和获取位置的查询参数46

2.5.2 使用相对位置存在的问题47

2.5.3 使用绝对位置来获取数据48

2.5.4 用于过滤的参数49

2.5.5 查询参数和路径的使用区别52

2.6 登录与OAuth 2.053

2.6.1 access token的有效期和更新58

2.6.2 其他Grant Type59

2.7 主机名和端点的共有部分61

2.8 SSKDs与API的设计63

2.9 HATEOAS和REST LEVEL3 API64

2.9.1 REST LEVEL3 API的优点67

2.9.2 REST LEVEL3 API67

2.10 小结68

第3章 响应数据的设计69

3.1 数据格式69

3.2 使用JSONP74

3.2.1 支持JSONP的操作方法75

3.2.2 JSONP与错误处理77

3.3 数据内部结构的思考方法79

3.3.1 让用户来选择响应的内容81

3.3.2 封装是否必要82

3.3.3 数据是否应该扁平化83

3.3.4 序列与格式85

3.3.5 该如何返回序列的个数以及是否还有后续数据88

3.4 各个数据的格式90

3.4.1 各个数据的名称90

3.4.2 如何描述性别数据92

3.4.3 日期的格式95

3.4.4 大整数与JSON96

3.5 响应数据的设计97

3.6 出错信息的表示98

3.6.1 通过状态码来表示出错信息98

3.6.2 向客户端返回详细的出错信息99

3.6.3 如何填写详细的出错信息101

3.6.4 发生错误时防止返回HTML102

3.6.5 维护与状态码102

3.6.6 需要返回意义不明确的信息时103

3.7 小结104

第4章 最大程度地利用HTTP协议规范105

4.1 使用HTTP协议规范的意义105

4.2 正确使用状态码107

4.2.1 2字头状态码：成功109

4.2.2 3字头状态码：添加必要的处理111

4.2.3 当客户端请求发生问题时113

4.2.4 5字头状态码：当服务器端发生问题时115

4.3 缓存与HTTP协议规范116

4.3.1 过期模型117

4.3.2 验证模型120

4.3.3 启发式过期122

4.3.4 不希望实施缓存的情况123

4.3.5 使用Vary来指定缓存单位123

4.3.6 Cache-Control首部125

4.4 媒体类型的指定127

4.4.1 使用Content-Type指定媒体类型的必要性129

4.4.2 以x-开头的媒体类型130

4.4.3 自己定义媒体类型的情况131

4.4.4 使用JSON或XML来定义新的数据格式的情况132

4.4.5 媒体类型与安全性133

4.4.6 请求数据与媒体类型134

4.5 同源策略和跨域资源共享136

4.5.1 CORS基本的交互137

4.5.2 事先请求138

4.5.3 CORS与用户认证信息139

4.6 定义私有的HTTP首部139

4.7 小结141

第5章 开发方便更改设计的Web API143

5.1 方便更改设计的重要性143

5.1.1 公开发布的API144

5.1.2 面向移动应用的API145

5.1.3 Web服务中使用的API145

5.2 通过版本信息来管理API146

5.2.1 在URI中嵌入版本编号147

5.2.2 如何添加版本编号149

5.2.3 在查询字符串里加入版本信息151

5.2.4 通过媒体类型来指定版本信息152

5.2.5 应该采用什么方法153

5.3 版本变更的方针153

5.4 终止提供API155

5.4.1 案例学习：Twitter废除旧版本的API156

5.4.2 预先准备好停止服务时的规范156

5.4.3 在使用条款中写明支持期限159

5.5 编排层160

5.6 小结162

第6章 开发牢固的Web API163

6.1 让Web API变得安全163

6.2 非法获取服务器端和客户端之间的信息165

6.2.1 用HTTPS对HTTP通信实施加密165

6.2.2 使用HTTPS是否意味着100％安全167

6.3 使用浏览器访问API时的问题169

6.3.1 XSS169

6.3.2 XSRF174

6.3.3 JSON劫持176

6.4 思考防范恶意访问的对策180

6.4.1 篡改参数181

6.4.2 请求再次发送183

6.5 同安全相关的HTTP首部185

6.5.1 X-Content-Type-Options185

6.5.2 X-XSS-Protection186

6.5.3 X-Frame-Options186

6.5.4 Content-Security-Policy187

6.5.5 Strict-Transport-Security187

6.5.6 Public-Key-Pins188

6.5.7 Set-Cookie首部和安全性189

6.6 应对大规模访问的对策191

6.6.1 限制每个用户的访问192

6.6.2 限速的单位194

6.6.3 应对超出上限值的情况195

6.6.4 向用户告知访问限速的信息198

6.7 小结204

附录A 公开Web API的准备工作205

A.1 提供API文档205

A.2 提供沙盒API206

A.3 API Console207

A.4 提供SDK209

附录B Web API确认清单211