我可以在招摇中创建丰富，动态的“实施说明”吗？

Question

我目前正在使用ApiOperation注释来记录“实施说明”部分中的Web服务方法：

@ApiOperation(
    value = "Searches for information",
    notes = "This service searches for information"
)
public Response getInformation(...)

我想现在增强我的笔记，使用属性文件，数据库中的信息等。我希望它丰富而动态。

所以，假设我有一个包含数据库信息的POJO：

@Entity
public class SortColumnField {
    @Id
    @Column
    private String fieldName;
    @Column
    private String fieldDescription;
}

是否有某些东西可以让我从像这样的对象生成招摇文档？

Answer 1

你有两种选择。

首先，notes部分支持markdown，特别是github-flavoured。您可以在该部分中获得相当丰富的信息，大多数工具都会正确呈现它。

接下来，Operation Object支持名为SELECT c.commentid, c.content, COUNT(r.replies) FROM comment c JOIN replies r ON r.commentid = c.commentID GROUP BY c.commentid, c.content; 的字段。虽然没有在Swagger-UI中呈现，但您可以轻松地将UI分叉以引用可能不适合标准工具中呈现的结构的复杂文档。