OpenAPI - 什么是OpenAPI？

随着世界正在向基于服务的应用程序和最先进的微服务发展，程序员为他们的RESTful API提供标准接口定义变得至关重要。这就是OpenAPI派上用场的地方。也称为OpenAPI规范（OpenAPI），可帮助开发人员在涉及多个协议、接口和环境时简化应用程序开发。它通过提供一个可以访问数据的单一界面来实现这一点。

然而，在我们详细讨论OpenAPI之前，需要了解它是什么，它的用途以及为什么每个软件开发人员都应该使用它。

什么是OpenAPI规范？

OpenAPI规范以前称为Swagger规范，是一种开源格式和倡议，用于设计和创建机器可读的接口文件，用于生产，描述，消费和可视化RESTful API和Web服务。开放的API文件允许软件开发人员定义其API的要素，包括：

呈现端点和每个端点的操作
输入输出操作参数
认证技术
联系信息、使用条款、许可证等

使用标准定义的主要优点是，第三方用户可以使用最少的实现逻辑与服务交互并理解服务，只要他们熟悉RESTful API基础知识。API规范是用YAML或JSON编写的，这些格式对于机器和人类来说都是可读的，易于学习。

OpenAPI和Swagger一样吗？

虽然术语OpenAPI和Swagger是同义使用的，但它们不是一回事。如前所述，OpenAPI是用于描述、生成、使用和可视化RESTful API和Web服务的规范。它由OpenAPI Initiative提供支持;该组织由Microsoft，Google，Capital，Swagger和IBM等知名公司组成。

另一方面，Swagger是一家与一些用于实现OpenAPI规范的业界最强大的工具相关联的公司。它拥有大量的软件，包括开源、免费和商业工具，所有这些都可以在API生命周期的各个阶段使用。

由于Swagger参与了原始Swagger规范的创建，因此其工具通常与OpenAPI规范同义。但是，您必须了解，除了Swagger工具之外，其他工具也可以用于实现OpenAPI规范。

OpenAPI是用来做什么的？

除了帮助消费者理解远程服务并与之交互，而不需要相反的实现逻辑，OpenAPI还可以用于其他事情。其中包括：

为API生成服务器存根
为您的API生成超过40种语言的客户端库
使用spec将API相关工具与您的API连接起来
创建交互式API文档，允许用户直接在浏览器中测试API调用。
代码生成工具也可以使用它来生成服务器的sdk和客户端多种编程语言、测试工具和许多其他用例中的CDK。

我应该使用OpenAPI吗？

尽管开发和允许机器可读的API描述已经付出了不懈的努力，但是没有任何规范能够与OpenAPI等各种供应商的多功能性、全面性和支持相匹配。因此，作为一名开发人员，您必须加入在开发生命周期中使用OpenAPI规范的潮流。

以下是您应该使用OpenAPI的原因

最大限度地减少错误和调试时间

编码是一个需要时间的过程。由于这个原因，bug很有可能悄悄地出现。这可能会导致各种错误，浪费宝贵的时间。然而，软件开发人员可以使用OpenAPI来避免所有这些麻烦。该规范拥有一流的工具，可用于将定义转换为代码，从而最大限度地减少编写代码所需的工作量和时间。

允许协作式API设计

设计是API开发生命周期中最关键的阶段。API是一种需要服务器、各方和客户端严格遵守的契约。因此，API设计阶段应该涉及多个利益相关者，以保证一致性和效率。

开放API定义在这个阶段很方便。使用fork、issue tracker和pull request，开发人员可以鼓励驻留在GitHub等存储库中的正式纯文本文档的协作。这将确保实现和文档是链接的，并且在所有自动化的持续集成过程中一切都是同步的。

使您能够生成无缝的交互式文档

文档已成为现代API开发的重要组成部分。这是因为它不仅可以帮助开发人员了解如何使用API，还可以吸引他们尝试新的API。大多数程序员喜欢交互式文档，它允许他们在阅读之后立即测试API操作。

OpenAPI拥有强大的工具，如Swagger UI，它提供了集成测试客户端的API文档。它还提供各种开源解决方案，允许您为API生成尖端文档。使用OpenAPI将确保您创建的文档将完全覆盖您的API，并正确列出所有参数，方法和响应。

允许您分析并保证质量

OpenAPI允许您沿着API设计工作流测试系统的每个部分。这是因为OpenAPI定义是机器可读的，可用于评估API的质量。该规范允许您对API进行手动测试或集成自动化功能和性能测试。

对于大型API部署，您可以使用API网关来评估传入和传出流量，以确定其是否符合规范。执行这些测试和分析可以确保您的API是最佳的，从而降低故障的可能性。

由全球知名企业支持

OpenAPI规范得到了一些世界领先的软件组织的支持，如Microsoft、Google、Capital、Swagger和IBM，这些组织将其作为设计RESTful API的标准。它被数百万程序员和企业用于开发他们的API，无论是内部还是面向客户端。