内容简介
>通过模式发现API设计面临的挑战并采取相应的解决措施
>合理规划API端点和操作
>设计请求消息和响应消息及其表示形式
>优化消息设计以提高质量
>规划API的演进
>编写API契约并向相关方传达这些契约
>搭配使用各种模式以解决实际问题,并做出正确的权衡
目录
第Ⅰ部分 基础知识概述
第1章 API基础知识 3
1.1 从本地接口到远程API 3
1.1.1 分布式系统和远程API概述 4
1.1.2 远程API：通过集成协议访问服务 5
1.1.3 API的重要性 6
1.2 API设计中的决策驱动因素 11
1.2.1 API的成功要素 11
1.2.2 API设计有何不同 12
1.2.3 API设计难在哪里 12
1.2.4 架构方面的重要需求 14
1.2.5 开发者体验 15
1.3 远程API的领域模型 16
1.3.1 通信参与者 16
1.3.2 API端点提供描述操作的API契约 17
1.3.3 消息是对话的组成部分 17
1.3.4 消息结构和表示 18
1.3.5 API契约 19
1.3.6 全书使用的领域模型 20
1.4 本章小结 20
第2章 Lakeside Mutual案例研究 23
2.1 业务背景和要求 23
2.1.1 用户故事和期望的系统质量 23
2.1.2 分析级别的领域模型 24
2.2 架构概述 26
2.2.1 系统上下文 26
2.2.2 应用程序架构 27
2.3 API设计活动 29
2.4 目标API规范 29
2.5 本章小结 30
第3章 API决策叙述 33
3.1 前奏：模式作为决策选项，设计驱动力作为决策标准 33
3.2 API的基础性决策和模式 35
3.2.1 API可见性 36
3.2.2 API集成类型 39
3.2.3 API文档 41
3.3 API角色和职责的相关决策 43
3.3.1 端点的架构角色 44
3.3.2 剖析各类信息持有者角色 46
3.3.3 定义操作职责 50
3.4 选择消息表示模式 52
3.4.1 表示元素的扁平结构与嵌套结构 54
3.4.2 元素构造型 58
3.5 插叙：Lakeside Mutual案例中的职责和结构模式 61
3.6 API质量治理的相关决策 62
3.6.1 API客户端的识别和身份验证 63
3.6.2 对API的使用情况进行计量和计费 65
3.6.3 防止API客户端过度使用API 67
3.6.4 明确规定质量目标和处罚机制 69
3.6.5 报告和处理错误 70
3.6.6 显式上下文表示 71
3.7 API质量改进的相关决策 73
3.7.1 分页 73
3.7.2 避免非必要数据传输的其他手段 76
3.7.3 处理消息中的引用数据 79
3.8 API演进的相关决策 81
3.8.1 版本控制和兼容性管理 83
3.8.2 版本发布和停用的相关策略 85
3.9 插叙：Lakeside Mutual案例中的质量和演进模式 88
3.10 本章小结 90
第Ⅱ部分 模式
第4章 模式语言简介 95
4.1 定位和范围 95
4.2 使用模式的原因和方法 97
4.3 模式一览 98
4.3.1 结构组织：按范围查找模式 98
4.3.2 主题分类：查找模式 99
4.3.3 时间维度：遵循设计完善阶段 100
4.3.4 浏览方式：从Map到MAP 101
4.4 基础模式：API可见性和集成类型 102
4.4.1 Frontend Integration模式 103
4.4.2 Backend Integration模式 104
4.4.3 Public API模式 105
4.4.4 Community API模式 106
4.4.5 Solution-Internal API模式 108
4.4.6 基础模式小结 109
4.5&
前言/序言
各 方 赞 誉
“API正在席卷全球。软件开发过程中的组织和协作越来越依赖于API。设计API时会遇到各种挑战，而使用模式是应对这些挑战的有效手段。本书有助于从业者提高API设计的效率：他们可以集中精力设计自己的应用程序，而标准的设计问题则可以通过使用模式解决。对于从事API相关工作的人士来说，本书会改变他们设计和理解API的方式。”
——Erik Wilde
Axway公司Catalyst团队成员
“五位作者通过浅显易懂的方式探讨了API生命周期中涉及的各种设计模式，本书涵盖从定义到设计的各个阶段。无论是已经写过几十个Web API的老手，还是刚刚接触这一领域的新手，都能从阅读本书中受益。书中介绍的模式有助于保持API设计具有一致性，并帮助开发人员应对设计过程中可能遇到的各种挑战。本书非常值得一读。”
——James Higginbotham
《Web API设计原则》作者
LaunchAny公司创始人、首席API顾问
“如今，API在软件开发领域无处不在。API设计看似简单，但是所有饱受糟糕设计之苦的开发人员都有体会，掌握API设计的技巧并不容易，它远比表面看到的现象要精细和复杂。本书的五位作者运用丰富的经验和多年研究工作的成果，创建出一套关于API设计的结构化知识体系。本书不仅可以帮助读者理解用于构建高质量API所需掌握的基本概念，而且会提供一套实用的模式，可供开发人员在构建自己的API时使用。本书适合所有从事现代软件系统设计、开发或测试的人士阅读。”
——Eoin Woods
Endava公司首席技术官
“在系统设计(尤其是在日益主导软件生态系统的分布式系统设计)中，需要进行大量权衡取舍，而API是帮助管理这些权衡取舍的关键要素之一。在我看来，本书通过使用易于理解的概念来消除API理解和设计过程中呈现出的复杂性，无论是已有一定经验的工程师，还是刚刚开始从事软件工程和架构设计的新人，都不难理解书中讨论的内容。如果你希望在系统设计中发挥关键作用，那么掌握书中介绍的API设计概念和模式至关重要。”
——Ipek Ozkaya
美国卡内基梅隆大学软件工程研究所软件解决方案部智能软件系统工程技术总监
2019—2023年《IEEE软件》期刊主编
“我相信，在当今这个时代中，‘API优先’设计将成为大型复杂系统设计的主旋律。正因为如此，本书的出版恰逢其时，值得所有架构师一读。”
——Rick Kazman
美国夏威夷大学马诺阿分校教授
“终于看到系统探讨API设计这一重要话题的著作了！真希望能早几年读到本书，书中介绍的模式非常有用。”
——Gernot Starke博士
INNOQ研究员
“在我看来，某些软件项目之所以失败，是因为中间件技术掩盖了系统的分布式特性：程序员设计出适用于集中式系统的API，但是在分布式环境中远程调用这种API时就会出现问题。本书探讨了在相互依存的世界中软件所需具有的分散性，并给出了设计各部分功能模块之间的接口时长期适用的建议。书中介绍的模式并不局限于某种特定的中间件技术，它们既能帮助开发人员创建和理解互联软件系统，也有助于管理这些系统目前和今后在功能上的必要演进。这些系统不仅在全球范围内的业务中发挥着作用，而且广泛应用于汽车、房屋以及日常生活所依赖的几乎每一项技术中。”
——Peter Sommerlad
独立咨询顾问
《面向模式的软件架构(卷1)：模式系统》作者
Security Patterns作者
“本书堪称软件工程师和架构师在API设计、演进、文档化方面的‘瑞士军刀’。我特别欣赏本书的一点是，五位作者并没有简单地将模式抛给读者，而是围绕现实示例进行解释，并提供实践性的架构决策支持，还通过案例研究来剖析模式和决策，因此理解书中介绍的模式语言可谓易如反掌。读者可以直接查找某个问题对应的解决方案，也可以通读各章以全面了解与API设计相关的问题和解决方案。所有模式经过精心设计且命名得体，并通过了从业者社区的同行评审。阅读本书是一种享受。”
——Uwe van Heesch博士
执业软件架构师
Hillside Europe前副总裁
“本书讨论的44种API模式涵盖各个方面，有助于软件工程师和架构师设计出具备互操作性的软件系统。五位作者不仅介绍了API的基础知识，还提供了大量研究示例。对于今后将要从事软件工程行业的人士来说，本书是一本优秀的教程。书中讨论的许多模式在实践中极为有用，已被应用于设计集成化、任务关键型铁路运营中心系统的API。”
——Andrei Furda
日立轨道STS澳大利亚分公司高级软件工程师
