15、API开发中四大支柱的综合运用与实践

API开发中四大支柱的综合运用与实践

1. API开发的四大支柱概述

在API开发过程中，有四个关键的支柱起着至关重要的作用，分别是设计、文档、开发和测试。这些支柱并非API开发所独有，在当今的软件开发中，无论是API还是其他软件，都要经历设计、开发、文档编写和测试这几个经典阶段。同时，也有许多软件开发方法可用于管理这些支柱的工作，如Kanban、Scrum和Scaled Agile Framework等，它们都在将敏捷原则应用于产品交付方面得到了广泛应用。

然而，API开发有其独特之处，它将许多不同的概念封装在一个可交付的产品中。开发者需要思考如何将这些支柱结合起来，使API的接口和实现提供最大的战略价值。目前，有三种常见的方法可以帮助开发者实现这一目标，分别是文档优先、代码优先和测试优先。

2. 三种API开发方法

2.1 文档优先

• 定义 ：文档优先的方法意味着团队优先设计API的用户界面，即文档。在开始时，团队不会先考虑使用Go、Java、NodeJS等语言进行实现的技术细节，而是在API实际存在之前就专注于对其进行文档记录。例如，在构建支付API时，可以先应用文档支柱中的决策和工作，再编写代码。
• 优点 ：可以在投入任何实现工作之前测试API的用户界面。例如，为新的支付API编写使用和示例指南，并与潜在开发者进行测试。根据他们的反馈更改文档比更改实际的API实现要容易得多。
• 实践建议 ：文档优先并不意味着只关注文档。在规范最终确定的同时，开始开发和测试活