首页 > 解决方案 > JAX RS:通过 maven 生成和验证 OpenApi3

问题描述

以下是我开发 Jax Rs/REST 服务的方式:

  1. 定义 REST API 模块:创建带有 Jax Rs 注释的 REST 接口。服务器组件依赖于这个模块。它也提供给客户,如果他们想使用它。

  2. 生成其余文档。Enunciate用于它。该文档包含在 war 文件中,可通过/docsurl 提供给客户端。

  3. 添加 GUI 以在运行时向服务器发送休息请求。通过Swagger. swagger.json也是swagger通过Enunciate.

  4. 现在很多客户要求您提供 OpenApi 3 规范的休息服务。帮助他们生成客户和模拟服务。好的,Enunciate也可以通过其他依赖项来实现,现在我还有openapi.yml文件,该文件被放入 Web 资源中,并且可以通过 url 访问客户端。

  5. 服务器端逻辑实现其余接口。

  6. 休息客户端使用接口并生成代理。

我的问题是:如何openapi.yml在 Maven 构建过程中验证这个文件。生成它的库可能不会这样做。如果它无效,我想看看文件中有什么问题。我需要它的验证模块之类的东西OpenAPI4J,但请检查 yml 文件本身。

我可能会创建一个自定义的 Maven 插件,但希望已经有一个现有的解决方案。现在我发现了很多关于 OpenApi 的示例,但它们都是关于如何从规范文件生成存根或客户端代码的。我找不到任何关于验证的信息。

如果我使用 openapi.yml 的方式有误并且我遗漏了什么,请告诉我。

标签: javarestmavenjax-rsopenapi

解决方案


推荐阅读