共计 1355 个字符，预计需要花费 4 分钟才能阅读完成。
假如你请承包商从零开始建造一座房子，你必定冀望他们交付最高品质的房子。他们必须通过查看、恪守平安标准并遵循我的项目中约定的要求。因为建房子可容不得走捷径。如果承包商常常走捷径，他们的名誉会受到影响，从而失去客户。其实，开发 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 所带来回报值得投资。疏导他们浏览选项，以便他们不用做出假如，并在假如不正确时感到丧气。
5、投放市场
你的成品曾经通过测试和查看，筹备向公众展现！通过创立一个建设在坚实基础上并且有良好文档记录的货色，这样任何看到它的人都会晓得外面到底是什么。无论你是在建造屋宇还是 API，请发明出让本人感到自豪的货色。公布一些可能引起人们留神的货色，这是你发明出惊人之物的机会，在这个环节也要多花点心理。
【Eolink 翻译】原文链接：《How to Build an API From The Ground Up》
