当您要求承包商从零开始建造一栋房屋时，您期望他们交付最高水准的产品。
他们必须通过检查，遵守安全规范，并遵循项目商定的要求。建筑行业偷工减料会产生严重后果。如果承包商多次偷工减料，他们的声誉可能会受到影响，人们将不会再要求他们建造房屋。
在许多情况下，开发 API 时的风险同样高。
构建 API 时，在将其发布到世界之前，创建开发者乐于使用和信任的、功能完善的最终产品至关重要。如果一切顺利，您会希望扩展您的 API 策略，但如果没有正确的流程，您可能会在一个有缺陷的基础上构建 API 项目，从而危及您的长期成功。
一切都始于制定正确的计划。
计划
就像承包商在开始建造新建筑时依赖蓝图一样，您需要在开始构建 API *之前*制定计划。不要让您的 API 成为 API 世界的“比萨斜塔”。
幸运的是，API 架构师有蓝图可循。OpenAPI 规范就是其中一种蓝图。
OpenAPI 规范（前身为“Swagger 规范”）旨在提供一种标准格式，使开发者能够创建易于跨国界、技术栈和行业理解和使用的 API。
试图使用 OAS 与 API 集成的人员应该能够剖析并确切理解该 API 提供什么。
就像蓝图为建筑的建造方式提供了清晰的指令一样，OpenAPI 规范也为 API 的构建方式提供了清晰的设计结构。
它让业务和技术利益相关者在任何开发开始之前就知道 API 将包含什么。这个过程被称为“设计优先”方法，其中 API 规范处于项目的最前沿。
从一开始就遵循 OpenAPI 规范，也使得开发者在构建 API 时能够更快地启动，因为所有相关信息都已明确。
Swagger Editor 非常适合快速开始使用 OpenAPI 规范。它简洁、高效，并配备了许多功能，可帮助您开箱即用地设计和文档化您的 RESTful 接口。
- 该编辑器可在任何开发环境中工作，无论是本地还是网络。
- 在编写时验证您的语法是否符合 OpenAPI 规范，并获得简洁的反馈和错误处理。
- 可视化呈现您的 API 规范，并在定义时与您的 API 进行交互。
您可以免费下载开源的 Swagger Editor，或在 SwaggerHub 平台中获取该编辑器。
构建
您已经花费了数小时、数天、数周、数月的时间来完善您的 API 设计，现在终于到了开始构建的时候了。建造房屋时，为您的项目配备合适的团队和正确的工具非常重要。
构建 API 也是如此。有许多工具可以帮助您轻松高效地构建 API。
API 开发者工具箱中始终应备有的工具之一，尤其是在使用 OAS 构建时，就是 Swagger Codegen。Swagger Codegen 是另一个开源工具，它允许 API 开发者通过生成 30 多种不同语言的样板代码来快速构建 API 原型。
检查
这一步对于成功至关重要。您的项目，无论是房屋还是 API，都必须经过测试和检查以发现错误和缺陷，这非常重要。在进行房屋检查时，通常有一套通过检查所需的要求。
许多公司不测试他们的 API。同样，我们认为建筑检查员应该确保新房的建造符合要求。但现实中并非总是如此。
创造“足够好”的产品与“完美”的产品各有利弊。在软件开发中，发布一个“足够好”的首个产品对某些人来说是完全可接受的工作流程，但您应该确保它“足够好”到可以投入使用。
Swagger 希望确保所有 API 都“足够好”以通过可用性测试，这也是我们构建 Swagger Inspector 的原因之一。它是一款在线 API 测试工具，可快速验证您的 API 是否按预期工作。
如果您确保交付的产品满足所有要求，从长远来看，您会做得更好。
描述 并文档化
太棒了，您的项目完成了。
它已经通过了检查并表现出色，现在您可以将其投放市场供所有人查看了。您的第一反应可能是直接发布，让您的 API 自己说话。请避免这样做！
文档化您的项目对最终用户非常重要。在我们的房屋示例中，您需要描述房屋的面积、所在社区、卧室和浴室数量、厨房电器类型、厨房里美丽的自然光等。图片可能具有欺骗性，因此为潜在买家详细说明是关键。
您的 API 也是如此。文档化很难做，但提供一个易于使用的 API 所带来的回报非常值得投资。引导他们了解各种选项，这样他们就不必做出假设，然后因假设不正确而感到沮丧。
明确说明您提供什么以及它如何工作，人们会对结果更满意，因为他们不会觉得被误导。
幸运的是，对于各地的开发者而言，Swagger UI 允许您可视化并与 API 资源进行交互，而无需任何实现逻辑。它会根据您的 OpenAPI 规范自动生成，其可视化文档使后端实现和客户端消费变得容易。它允许最终开发者轻松地与您的 API 暴露的每一个操作进行交互和试用，以便于使用。在这里查看它的工作方式：这里。
推向市场
您的成品已经过测试和检查，并准备好向公众展示！您通过创建一个基础坚固、文档齐全的产品，使自己处于有利地位，这样任何查看它的人都会确切地知道里面有什么。
无论您是建造房屋还是构建 API，都要创造出您引以为傲的作品。发布一些能让人眼前一亮的东西。这是您创造非凡事物的机会，所以请花时间把它做好。
准备好开始构建了吗？
Swagger 助您一臂之力。立即开始使用 Swagger 工具进行构建
构建 API 的其他资源