Swagger Core Java 库首次支持 OAS 3.0

  2017年8月24日

Swagger 团队自豪地宣布 swagger-core 和 swagger-parser 的首批发布候选版本,新增对 OpenAPI Specification 3.0.0 (OAS 3.0) 的支持!

随着规范新版本的发布,我们确信用户都渴望尝试。此前,我们已在 Swagger UI 和 Swagger Editor 中发布了对 OAS 3.0 的支持,现在是 Java 世界迈出这一步的时候了。

新库的发布面向早期采用者,存在一些已知限制,详见下文。通过这次首次发布,我们期待您协助提交问题,甚至提交包含修复的 PR。请注意,作为发布候选版本,API 在最终发布之前可能会发生变化,从而为您的应用程序引入破坏性更改。

Swagger-core 和 Swagger-parser 的新功能一览

Swagger-core 是一组模块,支持与 JAX-RS 和 Servlets 等一些 Java 技术集成,以生成 OpenAPI 定义。然而,swagger-core 不仅如此——它还提供了一组模型来表示 OpenAPI 标准中的 API 定义,以及一组可用于使用附加信息装饰代码的注解。这两个模块都被 Swagger 工具集下的其他项目和社区工具使用。

新版本的 swagger-core 代表着代码的一次重大重写,目前版本号为 2.0.0-rc1。此版本提供了一些关键特性和更改

  • 仅支持 OAS3。与之前的 swagger-core 版本一样,只支持一个规范版本。
  • 作为一段时间以来的第一个主要版本发布——注解被完全重写并调整以支持规范的新版本。
  • 这意味着 swagger-core 2.X 相对于以前的版本是一个破坏性更改。
  • 当前的 RC 版本仅支持 JAX-RS2。
  • 代码库使用 Java 8。

我们鼓励您阅读完整的发布说明以获取更多信息。代码本身可以在2.0分支中找到,并将保留在那里直到官方稳定版本发布。未来几周内,我们还将在 Wiki 中提供更多关于新集成的文档。

我们的 OpenAPI 定义反序列化工具 Swagger-parser 也已发布,版本为 2.0.0-rc0。与 swagger-core 非常相似,它支持您读取 OAS3 定义并将其解析为模型树。该项目还包括一个从 OAS2 到 OAS3 的转换器,并在尝试解析此类定义时自动使用。与 swagger-core 类似,代码本身可以在 2.0 分支中找到,并将保留在那里直到官方稳定版本发布。

其他 Swagger Java 项目的下一步是什么?

很高兴您提出这个问题!我们目前正专注于扩展 swagger-core,改进 swagger-parser 中的转换器,并实现支持 OAS3 的新版本 swagger-inflector

validator-badge 和 swagger-codegen 将是接下来的重点!

如需了解 Swagger 团队发布的最新更新,您可以在 Twitter 上关注我们 @SwaggerAPI 或订阅博客侧边栏。

© . All rights reserved.