帶有Java Rest Service的Swagger UI

Question

我是使用Swagger文檔的新手。 我在Java rest服務類上使用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傳遞數據，則需要為每個字段添加一個值。 例如，城市，郵政編碼和州。

但我相信您真正想做的是將JSON作為HTTP POST方法發布，在這種情況下，您將刪除@FormParam並將值消耗到具有有效負載字段的Java對象中。