Exclude Models or properties from swagger response

Question

I used swagger in my apache cxf project , used @Api and @ApiOperations and @ApiParam annotations and generated a api doc for the rest services.

But I want to exclude

Answer 1

First of all, you should upgrade to the latest swagger-core version, currently 1.3.12 (you're using a really old one).

You have 3 ways to hide a property:

1. If you're using JAXB annotations, you can use @XmlTransient.
2. If you're using Jackson, you can use @JsonIgnore.
3. If you're not using either, or don't want to affect the general de/serialization of your models, you can use Swagger's @ApiModelProperty's hidden attribute.

Keep in mind you may need to set these on your getters/setters rather than on the property itself. Play with the definitions to see what works for you.

With regards to the issue with the User model, the problem is that you do not reference it from the @ApiOperation (you also don't need the httpMethod property). Try changing it as follows:

@ApiOperation(value = "xxx", notes = "user details", response =  User.class)

Answer 2

You can exclude fields like that :

@ApiModelProperty(position = 1, required = true, hidden=true, notes = "used to display user name")