swagger ui with collection (List) input parameter for Jax Rs resource

Question

How to configure swaggerui to display correct parameter datatype for JAX-RS resources which have collection input parameters?

Below is a sample groovy JAX-RS resource. Its input is of type List<User>

@POST
@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")
Response createUsers(List<User> questions) {
}

In the swagger UI, I see the List with empty type populated instead of User. It works fine for output parameters. Using ApiOperation annotation, I could specify for response type.

@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")

For input parameters, How do I see List of User model schema in the swagger UI? enter image description here

Marcin M. · Accepted Answer · 2014-08-13 08:52:43Z

4

Try using @ApiParam on List:

@POST
@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
@ApiOperation(value = "Create(s) users", response = User, responseContainer = "List")
Response createUsers(@ApiParam("description") List<User> questions) {
}

answered Aug 13, 2014 at 8:52

Marcin M.

563 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

suman j Over a year ago

Exactly what I needed. Thnx

Collectives™ on Stack Overflow

swagger ui with collection (List) input parameter for Jax Rs resource

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related