首页 > 解决方案 > 如何将 HAL JSON 转换为 OpenAPI JSON 以生成 JavaScript 客户端 API

问题描述

我们有一个生产 HAL JSON 的 Spring Data Rest 项目。我们希望自动生成基于 HAL JSON 的 JavaScript 客户端 API。我们可以使用 OpenAPITools/openapi-generator 非常简单地将 OpenAPI JSON 转换为 JS 客户端 API,但我们一直无法找到用于 HAL JSON 的类似工具。作为一种解决方法,我们正在探索将 HAL JSON 转换为 OpenAPI JSON 以利用 OpenAPITools/openapi-generator 项目。

是否存在 HAL JSON 到 OpenAPI JSON 转换器?

是否有 HAL JSON 到 JavaScript 客户端 API 生成器?

有没有办法跳过 HAL JSON 步骤并从 Spring Data Repository 类生成 OpenAPI JSON?

标签: javascriptopenapiopenapi-generatorspringdochal-json

解决方案


要启用 spring-data-rest 类型的支持:@RepositoryRestResource 和 QuerydslPredicate 注释,您应该使用:

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-data-rest</artifactId>
      <version>1.4.8</version>
</dependency> 

您可以在此处获得演示:


推荐阅读