使用Java Rest Service的Swagger UI

Question

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

我的休息方法如下：

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

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

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

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

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

Answer 1

如果您要在@FormParam中传递数据，则需要为每个字段添加值。例如，city，zipCode和state。

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