Интерфейс Swagger с сервисом обслуживания Java

Question

Я новичок в использовании документации Swagger. Я использую аннотации Swagger в классе обслуживания Java rest. Не могли бы вы предоставить некоторую помощь по следующей проблеме -

Мой метод остальное, как показано ниже:

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

Как вы видите, я передаю параметр JSON String - адрес для моего метода отдыха. На стороне Javascript, у меня есть следующий код, чтобы настроить данные -

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

Я теперь посылаю это к методу отдыха по телефону JSON.stringify(addressMap).

В Swagger-UI у меня есть только один параметр для ввода. Как я могу позволить пользователю узнать, что это сложный объект, и им нужно передать данные о городе, zipcode и состоянии.

Answer 1

Если вы передаете данные в @FormParam, вам нужно добавить значение для каждого из полей. Например, город, zipCode и состояние.

Но я верю, что вы действительно хотите сделать сообщение JSON как метод HTTP POST, в этом случае вы должны удалить @FormParam и использовать значения в объекте java, который имеет поля в полезной нагрузке.