API 设计决定了不同组件如何通信，使其成为许多软件应用程序的基石。通常，开发人员在实现 API 时可以选择两种方法：代码优先或设计优先。尽管这两种方法各有利弊，但选择正确的方法可以显著影响您的开发工作流程。
本文将探讨代码优先和设计优先方法之间的差异、API 探索如何融入每种方法，以及如何为您的项目选择最佳方案。
传统上，代码优先的 API 开发方法速度更快，但借助新工具，设计优先的方法可以帮助实现短期速度和长期一致性。
代码优先 vs. 设计优先
顾名思义，代码优先方法涉及先编写代码，然后再进行文档记录。开发人员通常使用此方法来构建 API 的模型、方法和数据访问层。然后他们再使用工具从代码生成 API 文档。
代码优先方法可能适用于对 API 设计要求有清晰理解的开发人员。通过在文档编写之前编写代码，他们可以缩短上市时间并更快地发布。特别是，它可能是一种适用于快速原型开发、小型团队或高度迭代开发项目的好方法。
然而，这种方法使得其他利益相关者（如测试人员和技术文档编写者）更难理解 API。他们可能不得不深入研究 API 代码库并使用 API 探索工具来了解其工作原理，而不是参考精确的 API 定义来编写自动化测试或撰写文档。
设计优先方法涉及在编写任何代码之前创建详细的 API 定义。虽然这听起来更耗时，但开发人员可以使用这些定义（例如 OpenAPI 规范）来生成多种编程语言的代码，并在很短的时间内提高跨实现的一致性。
更重要的是，设计优先方法能让所有人保持同步。在达成 API 定义共识后，测试人员和技术文档编写者可以与开发人员并行工作。在许多情况下，结果是多种实现更快上市、文档更一致以及测试更可靠。
API 探索如何融入
API 探索是测试和与 API 交互以了解其行为和能力的过程。例如，测试人员可能会使用 cURL 或像 SwaggerHub Explore 这样的工具向 API 发送请求并检查响应。前端开发人员可能会尝试使用 API 为其组件提供数据并交付用户故事。
SwaggerHub Explore 是一个易于使用的工具，可帮助开发人员与多协议 API 进行交互和探索。发出请求后，您可以轻松评估响应并存储请求和参数以供将来使用。更深层次地，它使您能够即时可视化 API 数据，以便在投入 API 集成之前评估其功能和局限性。
SwaggerHub Explore 的空间使得存储 API 和搜索历史变得容易。来源：SwaggerHub
API 探索与设计优先方法结合时最为有用，因为开发人员可以使用 OpenAPI 规范在探索过程中创建用于测试的示例请求和响应。在已有 API 定义的情况下开发自动化测试也更容易，同时确保 API 符合治理约束。
然而，代码优先方法可能更适合探索性测试，因为它允许开发人员快速原型化 API 并测试其功能。当不切实际地做出 API 设计决策时（例如，项目处于早期阶段，设计可能会发生很多变化），它也很有帮助。
SwaggerHub 如何提供帮助
SwaggerHub 通过实施基于 OpenAPI 的设计标准来加速 API 开发。此外，该平台通过强制执行风格标准的编辑器以及提供最新的交互式文档，实现了更紧密的协作。
SwaggerHub 在强制执行质量和风格一致性的同时，加速您团队的设计流程。来源：SwaggerHub
例如，SwaggerHub 的 API 自动模拟集成根据您的定义创建并维护一个半静态的 API 模拟。每次您保存 API 时，它都会更新。这样，开发人员可以在设计 API 时，在实现之前对其进行测试。您甚至可以在后端准备好之前开始构建客户端应用程序。
在您构建 API 时，SwaggerHub 强大的编辑器根据您的 OpenAPI 规范提供智能错误反馈和语法自动补全功能，以加速开发。风格验证器确保多个 API 之间的一致性，从而改善开发人员体验。最后，域使得在众多 API 之间轻松存储、复用和引用通用语法成为可能，从而节省时间并提高一致性。
当您准备发布 API 时，SwaggerHub Codegen 可以自动生成客户端 SDK，使所有客户端都能轻松使用 API。您还可以生成服务器存根以启动开发过程并缩短上市时间。这些功能有助于弥合代码优先和设计优先方法之间的差距。
最后，如果您已经发布了 API，新推出的 SwaggerHub Explore 通过支持 REST 和事件驱动的 API 定义，使 API 探索变得轻而易举。例如，开发人员可以发送请求并立即收到响应，从而发现更多关于 API 行为的信息，并在集成过程中节省时间和精力。
总结
API 设计对于许多软件项目的成功至关重要。虽然有些团队偏爱代码优先方法，但新工具使得设计优先方法变得快速高效。例如，SwaggerHub 允许您自动模拟 OpenAPI 规范、生成 SDK 并进行探索性测试。
通过采用设计优先的方法，您可以利用 SwaggerHub Explore 等工具来导入和理解 API 定义，并启动其他活动。这些努力有助于加速软件开发过程并避免代价高昂的瓶颈。
立即免费试用 SwaggerHub Explore.