带有 Java Rest 服务的 Swagger UI答案

【问题标题】：Swagger UI with Java Rest Service带有 Java Rest 服务的 Swagger UI
【发布时间】：2023-03-11 23:25:01
【问题描述】：

我不熟悉使用 Swagger 文档。我在 Java 休息服务类上使用 Swagger 的注释。您能否就以下问题提供一些帮助 -

我的休息方法如下：

public String testMethod3(@ApiParam(value = "Mailing address of the user", required = true) @FormParam("address") final String address) {}

如您所见，我将一个 JSON 字符串参数 - 地址传递给我的 rest 方法。在 Javascript 方面，我有以下代码来设置数据 -

var addressMap = {};
addressMap.city = 'SS';
addressMap.zipCode = '98877';
addressMap.state = 'CA';

我现在通过调用 JSON.stringify(addressMap) 将其发送到 rest 方法。

在 Swagger-UI 中，我只能输入一个参数选项。我怎样才能让用户知道这是一个复杂的对象，他们需要传递城市、邮政编码和州的值。

【问题讨论】：

【解决方案1】：

如果您在 @FormParam 中传递数据，则需要为每个字段添加一个值。例如，城市、邮政编码和州。

但我相信您真正想要做的是将 JSON 作为 HTTP POST 方法发布，在这种情况下您将删除 @FormParam 并将值消耗到具有有效负载中的字段的 java 对象中。

【讨论】：

非常感谢。我创建了一个 Java 类并放置了所有这些属性，并将该类用作参数。 swagger UI 现在将参数类型显示为“body”并提供 JSON 字符串。谢谢。
另外，我想知道 Swagger 是否支持不同的请求和响应模型模式。