当您要求承包商从头开始建造房屋时，您希望他们交付最高水平的产品。
他们必须通过检查，遵守安全规范，并遵循项目商定的要求。在建筑行业偷工减料可能会产生严重的影响。如果承包商多次偷工减料，他们的声誉可能会受到威胁，人们不会再请他们盖房子。
在许多情况下，开发 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 接口。
- 该编辑器可以在任何开发环境中工作，无论是在本地还是在 Web 中。
- 在您编写时，使用简洁的反馈和错误处理来验证您的语法是否符合 OpenAPI 规范
- 在您仍然定义 API 时，以可视化方式呈现您的 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 的其他资源