@ApiParam(hidden = true) on property with object as type is ignored

[alexpeelman]

I use Spring MVCs ModelAttribute to map query parameters to an object encapsulating the fields.

public String getTargets(@ModelAttribute TargetRequest request, Model model) throws Exception {
...
}

But the TargetRequest class contains a field with an object as type, which is never used in the parameter mappings and may be ignored

public class TargetRequest {

    //bug in swagger? it is still shown
    @ApiParam(hidden = true)
    ErsEntity ersEntity;

}

Swagger introspects the object and for each primitive property in the top-down hierarchy, query parameter documentation is generated. I explicitly annotated the field to be hidden but no luck.

[sinboun]

I met you, too

[willcain]

If you are using SpringFox, a work-around is:

import springfox.documentation.spring.web.plugins.Docket;
...
docket.ignoredParameterTypes(ErsEntity.class);

Credit: https://github.com/springfox/springfox/issues/1139#issuecomment-171005465

[leonardocsc]

@ApiIgnore It'll get you where you want it。