2、构建优质 Web API：设计模式与实践指南

构建优质 Web API：设计模式与实践指南

1. 适用人群与目标

API 设计模式旨在为构建 Web API 提供一系列安全、灵活且可复用的模式。如果你正在构建或计划构建一个 Web API，尤其是该 API 将向公众开放，那么这些内容会对你有所帮助。虽然熟悉一些序列化格式（如 JSON、Google Protocol Buffers 或 Apache Thrift）或常见存储范式（如关系数据库模式）会更好，但这并非必需条件。此外，若你熟悉 HTTP 及其各种方法（如 GET 和 POST），那将是一个额外的优势，因为本书的示例中主要使用 HTTP 作为传输协议。当你在设计 API 时遇到问题，心想“肯定有人已经解决过这个问题了”，那么这里的内容就适合你。

2. 整体架构

整个内容分为六个部分：
- 第一部分：引言 ：为后续内容奠定基础，提供 Web API 及其设计模式的定义和评估框架。
- 详细定义 API 的含义，探讨好的 API 是什么样的，以及如何区分好的 API 和坏的 API。
- 深入研究设计模式的含义和结构，目标是依靠这些设计模式构建始终优质的 API。
- 第二部分：通用设计原则 ：进一步阐述构建任何 API 时应考虑的一些通用设计原则。
- 考虑 API 中各个组件的命名，以及命名时需要考虑的因素，强调命名的重要性。
- 深入研究大型 API 中多个资源之间的关系，提出决策时应思考的问题，并给出需要避免的示例。
- 探索 API 中不同数据类型及其默认值的使用，涵盖常见数据类型（如字符串和数字）以及更复杂的数