我正在使用Spring MVC来实现各种REST服务.对于文档,我使用的是Swagger.
这很好用,文档看起来不错,而且非常实用.我唯一的问题是文档的注释真的挤满了控制器类,尤其是错误代码注释.
例:
@ApiErrors(value = {
@ApiError(code = 123, reason = "Reason123"),
@ApiError(code = 124, reason = "Reason124"),
@ApiError(code = 125, reason = "Reason125"),
@ApiError(code = 126, reason = "Reason126"),
@ApiError(code = 127, reason = "Reason127") })
public void exampleFunctionImplementation() {
}
Run Code Online (Sandbox Code Playgroud)
在许多情况下,这会导致大量注释,其中真正的应用程序代码隐藏在其间的某个位置.此外,这个注释集经常重复,因为许多方法可能返回相同的错误代码集.
有没有选择通过将注释列表定义为其他类文件中的常量来缩短这一点?或许我可能忽略了一些更简单的事情?
我尝试在@ApiError某处定义项目数组,但这不会编译:
ApiError[] array = {ApiError(code = 123, reason = "Reason123")};
Run Code Online (Sandbox Code Playgroud)
如果有人能给我一个如何解决这个问题的提示,我会很高兴,在此先感谢!