如何在swagger UI模型上显示dto对象的结构和描述

时间:2018-10-06 11:57:04

标签: java spring-boot swagger swagger-ui

我有很多dto,它们已经由大头贴注释的@ApiModel和@ApiModelProperty描述了。

这里是dto对象。

第一个。

@Data
@ApiModel
public class CompleteUserTaskDTO {
    private static final Logger LOGGER = LoggerFactory.getLogger(CompleteUserTaskDTO.class);

    @NotNull(message = "error.user_task_complete_parameters_not_null")
    @ApiModelProperty(notes = "description")
    private Object parameters;

    public Object toDTO(Class<?> clz) {

        try {
            ObjectMapper mapper = new ObjectMapper();
            return mapper.convertValue(this.parameters, clz);
        }catch (Exception ex) {
            LOGGER.error("The parameters field value convert to the class -- {} instance failed. The parameters values are -- {}. ", clz.getName(), this.parameters);
            throw ex;
        }
    }
}

第二个。

@Data
@ApiModel
public class FirstApprovalCompleteVariableDTO {

    @NotNull(message = "error.task.first_approval.first_approve_result_not_null")
    @ApiModelProperty(notes = "description")
    private FirstApprovalResult firstApprovalResult;

    @ApiModelProperty(notes = "description")
    private Set<Long> extraInfoIds;

    @ApiModelProperty(notes = "description")
    private Set<Long> reUploadApplicationMaterialFileIds;
}

这是昂首阔步的UI的模型。但是以上对象的结构和描述未包含在模型中。

enter image description here

我希望swagger扫描@ApiModel批注映射的dto,并在swagger ui的模型上显示它们。

有人可以告诉我该怎么做吗?谢谢大家。

0 个答案:

没有答案