如何将 Swagger UI 添加到现有的 GXT 或 GWT 项目并使用当前的 GWT-RPC REST 请求？

Posted 2023-02-16

【中文标题】如何将 Swagger UI 添加到现有的 GXT 或 GWT 项目并使用当前的 GWT-RPC REST 请求？

【英文标题】：How to add Swagger UI to existing GXT or GWT project and use current GWT-RPC REST requests?

【发布时间】：2018-05-30 16:09:10

【问题描述】：

我们有有效的 GXT (GWT) 项目。 我们想为这个应用程序添加新的 javascript 前端。

我们可以使用来自 JavaScript 的当前 GWT-RPC REST 请求吗？ 如果是：如何为现有的 GWT-RPC REST 请求添加 Swagger UI？

【参考方案1】：

GWT-RPC 不是 REST 服务，因此无法使用 OpenAPI Specification 公开。

如果您的服务器是 Java 服务器，您可以使用一些 JAX-RS 实现（例如 jersey）来公开 REST 服务。并在客户端使用 RestyGWT 或 AutoREST 访问这些服务。

此时，您将使用 REST API。然后，您需要创建、公开和使用服务的 OpenAPI 规范。这里有一个使用 jersey 从您的 JAX-RS 接口公开 OpenAPI 规范的指南。

https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5

Swagger UI 是一个独立的应用程序。因此，您可以在新窗口中访问它，也可以使用 iframe 将其集成到您的 GWT 应用程序中。使用 JS 将 Swagger UI 加载到您的 GWT 应用程序中是可能的，但不必要的复杂 IMO。 jersey-swagger 指南包括在您的战争中作为静态资源公开的 Swagger UI。