我有一个DTO标注为API模型。此DTO还具有一些有用的功能。我正在尝试注释这些有用的功能。用@ApiOperation
或@ApiModelProperty
进行注释不会使此函数包含在生成的yaml文件中。您如何在DTO中注释此类方法?
@ApiModel(value = "Document information")
public class DocumentDto {
public enum DocumentType {
PDF,
WORD,
CSV
}
...
@NotNull
@ApiModelProperty(required = true, value = "document type", allowableValues = "PDF, WORD, CSV")
private DocumentType documentType;
...
@JsonIgnore
@ApiOperation(value = "is this document a PDF?")
public boolean isPDF() {
return documentType == DocumentType.PDF;
}
}