Как документировать неявно использование dto, когда мы используем класс сущности как api param?

Question

Есть проблема, когда мы используем ресурс Jersey2 с неявным использованием dto.

Пример:

@POST 
@ApiOperation(value = "Create pet", response = PetDTO.class) 
public Pet create(Pet pet) throws IOException { 
    return this.petService.save(pet); 
} 

В этом примере мы неявно получить petDto, как пары, и чем сопоставить его сущность.

Вопрос в том, как настроить чванство для документирования PetDTO как api param, а не для домашних животных?

Answer 1

Это можно сделать следующим способом:

@POST 
@ApiOperation(value = "Create pet", response = PetDTO.class) 
@ApiImplicitParams({ 
     @ApiImplicitParam(name = "Pet dto", 
     value = "pet", required = true, 
     dataType = "com.example.PetDTO", paramType = "body") 
}) 

public Pet create(@ApiParam(hidden = true) Pet pet) throws IOException { 
}