CODEWITHSUNDEEP
restcxfjax-rsswagger
LazyGuy
LazyGuy

Reputation: 711

Exclude Models or properties from swagger response

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 some of the fields like EntityTag, StatusType and MediaType etc from Models attribute or complete modules or properties attribute.

How to do that?

I was fetching data from db and setting it to user object and passing that user object to JAX-RS response builder.

Below is one of my DTO Object:

  @ApiModel
  public class User{
  private String name;
   private String email;


 @ApiModelProperty(position = 1, required = true, notes = "used to display user name")
 public int getName() {
    return name;
 }

 public void setName(String name) {
    this.name= name;
}

@ApiModelProperty(position = 2, required = true, notes = "used to display user email")
public int getEmail() {
    return email;
}

 public void setEmail(String email) {
    this.email= email;
 }

Now I don't see the User object fields or properties inside the Swagger returned json format.

my service class method response is : 

    @GET
    @ApiOperation(value = "xxx", httpMethod = "GET", notes = "user details", response =  Response.class)
   public Response getUserInfo(){
        User userdto = userdaoimpl.getUserDetails();
        ResponseBuilder builder = Response.ok(user, Status.OK), MediaType.APPLICATION_JSON);
        builder.build();
 }


<bean id="swaggerConfig" class="com.wordnik.swagger.jaxrs.config.BeanConfig">
    <property name="resourcePackage" value="com.services.impl" />
    <property name="version" value="1.0.0" />
    <property name="basePath" value="http://localhost:8080/api" />
    <property name="license" value="Apache 2.0 License" />
    <property name="licenseUrl"
        value="http://www.apache.org/licenses/LICENSE-2.0.html" />
    <property name="scan" value="true" />
 </bean>

Upvotes: 22

Views: 98885

Answers (2)

Loran92
Loran92

Reputation: 151

You can exclude fields like that :

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

Upvotes: 15

Ron
Ron

Reputation: 14830

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)

Upvotes: 40

Related Questions