如何从零开始构建 API ？

原创

API小达人 2023-06-07 15:28:04 ©著作权

©著作权归作者所有：来自51CTO博客作者API小达人的原创作品，请联系作者获取转载授权，否则将追究法律责任

假设你请承包商从零开始建造一座房子，你肯定期望他们交付最高质量的房子。他们必须通过检查、遵守安全规范并遵循项目中约定的要求。因为建房子可容不得走捷径。如果承包商经常走捷径，他们的声誉会受到影响，从而失去客户。其实，开发 API 就像建房子一样。

构建 API 时，在将其推向市场之前，创建一个完全功能的最终产品对于开发人员想要使用和信任至关重要。如果一切顺利，你将有希望扩展你的 API 策略，但是如果没有正确的流程，则可能在错误基础上构建 API 程序，并使长期成功面临风险。所有这些都始于制定正确计划。

1、计划

就像承包商在开始新建筑物时依赖蓝图一样，你需要在开始建构 API 之前制定计划。不要让你的 API 成为比萨斜塔。幸运的是，有一个 API 架构师的蓝图，OpenAPI 规范就是其中之一。OpenAPI 规范旨在提供一种标准格式，使开发人员可以创建易于跨国界、技术堆栈和行业理解和使用的 API。

试图使用 OAS 集成 API 的人应该能够分解和理解 API 提供的内容。就像蓝图清晰地说明了建筑物应该如何建造一样，OpenAPI 规范为API的构建提供了明确的设计结构。在任何开发之前，它让业务和技术利益相关者知道将包含在 API 中的内容。这个过程被称为“先设计后开发”的方法，其中 API 规范处于项目前沿。从一开始遵循 OpenAPI 规范也使得开发人员可以更快地构建出符合要求的 API，因为所有必要信息都已经列出来了。

2、建构

你花费了数小时、数天、数周甚至数月来完善你的 API 设计，现在终于是开始构建的时候了。建造房屋时，拥有适合项目的正确团队和正确工具非常重要。同样，在构建 API 时也是如此。有许多工具可以帮助你以简单高效的方式构建出你的 API。

3、检查

这一步对于成功至关重要。无论是家庭还是 API，都需要进行测试和检查以发现错误和缺陷。在进行房屋检查时，通常需要满足一系列要求才能通过检查。有很多公司不会测试他们的 API。同样，在新房建设上我们也假定建筑师应该确保施工质量良好，但实际情况并非总是如此。创建“足够好”与“完美”的东西各有利弊。在软件方面，“足够好”的第一个产品可以被认为是完全可接受的工作流程，但你应该确保它“足够好”以便使用。

4、描述和文档

太棒了，你已经完成了你的项目。它已经通过检查并且表现出色，现在你准备将其推向市场。你的第一反应可能是只需将其发布并让 API 自己说话，还不行！为最终用户记录你的项目非常重要。在我们房屋示例中，你需要描述平方英尺、所在社区、卧室和浴室数量、厨房电器类型、厨房美丽的自然光线等信息。图片可能会欺骗人，因此为潜在买家详细说明至关重要。对于你的 API 也是如此。编写文档很困难，但提供易于使用的 API 所带来回报值得投资。引导他们浏览选项，以便他们不必做出假设，并在假设不正确时感到沮丧。