带有详细说明的文档@ApiOperation

Question

在使用 @ApiOperation 记录操作时，有 notes 属性用于对操作进行详细描述。但是在注解中写很长的描述，会很麻烦，难以维护。

是否有更优雅的选项来引用外部文件或其他东西？

Answer 1

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