我们最近举办了一场免费的 Swagger 培训,名为《将 Swagger 添加到现有 API:如何大规模自动化“代码优先”到 OAS》。在本次培训中,我们探讨了为现有 API 生成和托管 OpenAPI 规范 (OAS) 的不同工具和策略。
在网络研讨会期间,我们收到了大量关于为使用各种语言开发 API 的团队提供的不同选项的问题。 我们还收到了关于 Swagger 工具如何提供帮助以及团队如何协调使用 OAS 进行 API 开发的不同方法的问题。
作为网络研讨会的后续,我们希望分享一些用于处理 OAS 的不同注解库的链接,并回答活动中 Swagger 用户提出的一些热门问题。
我们的 API 是使用 Java、C#、Python 等语言开发的。我在哪里可以找到这些语言的最佳注解库?
OpenAPI 规范 (OAS) 和 Swagger 工具都有活跃的开发者社区,他们使用和开发新工具来支持您的 API 开发。Swagger 团队支持其中一些用于从现有 API 生成 OAS 的库,其余由 OAS 社区维护:
您可以在此处探索其他支持 OAS 的开源工具。
我在哪里可以阅读更多关于使用 Gradle 或 Maven 在 SwaggerHub 中存储定义的信息?
SwaggerHub 提供了两个核心插件,用于自动化将生成的 OAS 定义导出到平台。
这些插件支持:
在此处了解有关 Gradle 插件的更多信息。
在此处了解有关 Maven 插件的更多信息。
我们使用 Swagger Codegen 项目生成服务器桩代码,我们有什么理由应该使用 SwaggerHub 来做这件事吗?
SwaggerHub 是由 Swagger Codegen 项目背后的同一个团队创建的。事实上,SwaggerHub 中的代码生成功能是基于开源项目的贡献运行的。
SwaggerHub 为您的团队提供了一个中央平台,以便在 OAS 的 API 开发中进行协作。SwaggerHub 提供了一个单一平台,用于托管 OAS 定义、协作设计和文档化您的 API,以及通过内置代码生成功能生成服务器桩代码和 SDK,而不是让单独的开发人员在其本地机器上使用开源工具孤立工作,或管理复杂的构建流程以支持大规模操作。
SwaggerHub 还与您信赖的 API 开发工具集成,无论您是需要推送到 API 网关、触发 Jenkins 构建,还是与源代码管理主机同步,SwaggerHub 都提供原生集成和插件以适应您的工作流程。
SwaggerHub 中 OAS 3.0 代码生成支持哪些语言?
我们正在 SwaggerHub 中继续推出对新语言的支持。以下是 OAS 3.0 支持语言的最新更新:
客户端
-
Dynamic-html
-
Html
-
Html2
-
Java
-
Jaxrs-cxf-client
-
Kotlin-client
-
Php
-
Scala
-
Swift3
-
Swift4
-
Typescript-angular
服务器桩代码
-
Jaxrs-resteasy
-
Jaxrs-resteasy-eap
-
Scala-akka-http-server
-
Spring
当 API 发生更改时,规范会怎样?它会自动更新 SwaggerHub 中现有的规范文档吗?
通过将源代码连接到像 SwaggerHub 这样的平台,可以将外部规范与构建过程中生成的版本保持一致。除此之外,SwaggerHub 还拥有强大的版本控制系统,允许智能地对多个团队、项目或变更进行编目,并将其存储在一个单一的真实来源中。
关于 API 网关部署,您是否能够在定义中直接添加验证,同时将其添加到规范中?
此功能通常不属于定义本身——我们会将生成的 OAS 交给一个文件,该文件将执行一系列请求,并根据定义的响应进行验证。有像Swagger Test Template 项目这样的代码驱动解决方案,也有许多 GUI 驱动的解决方案,允许导入 OAS 并轻松生成测试,例如ReadyAPI。
有没有办法将 SwaggerHub 评论转换为 JIRA 任务?
目前,我们没有直接集成到 JIRA。SwaggerHub 团队正在根据用户和组织的反馈,不断增加支持的工具和平台列表。
了解如何大规模自动化您的“代码优先”方法。
您可以在此处观看完整的培训录像。
准备好后,SwaggerHub 正在帮助各种规模的团队协调其使用 OAS 进行 API 开发——无论您是采用“设计优先”方法开始新项目,还是希望采用“代码优先”方法文档化现有 API 集。
立即免费开始。