文档@ApiOperation，详细描述详尽

Question

在使用@ApiOperation记录操作时，有notes属性用于操作的长描述。但是在注释中加入一个长描述使得它很麻烦且难以保留。

是否有更优雅的选项来引用外部文件或什么？

Answer 1

现在没有，没有。充其量，我可以建议使用字符串常量作为@ApiOperation的输入，并将其保留在其他位置以避免混乱。另一种选择是使用externalDocs，如果你使用的是swagger-core 1.5。