2017-06-21 58 views
0

诚然,我没看太硬的回答。我的问题是,通过定义使用springfox-招摇的UI招摇的注释时,一个人如何定义常见ApiResponse使用一个以上的方法和潜在的多个类?定义常见招摇注释

请参阅下面常见的两个示例方法ApiResponse是错误500.理想情况下,我想定义一次。任何最佳实践和/或建议?

示例代码如下:

@GET 
@Path("/greeting") 
@Produces(MediaType.APPLICATION_JSON) 
@ApiOperation(value = "Returns greeting details", notes = "Returns .....", response = Greeting.class) 
@ApiResponses(value = { 
    @ApiResponse(code = 200, message = "Successful retrieval of greeting details", response = Greeting.class), 
    @ApiResponse(code = 404, message = "Greeting does not exist"), 
    @ApiResponse(code = 500, message = "Internal server error")} 
) 
public Response getGreeting(.....) { 
    ... 
} 


@GET 
@Path("/something") 
@Produces(MediaType.APPLICATION_JSON) 
@ApiOperation(value = "Returns something details", notes = "Returns .....", response = Something.class 
@ApiResponses(value = { 
    @ApiResponse(code = 200, message = "Successful retrieval of greeting details", response = Something.class), 
    @ApiResponse(code = 404, message = "Something does not exist"), 
    @ApiResponse(code = 500, message = "Internal server error")} 
) 
public Response getSomething(.....) { 
    ... 
} 

具体指:

@ApiResponse(code = 500, message = "Internal server error") 

谢谢提前。

回答

0

由于@ApiResponse是一个注释,所以您需要为每个想要的方法添加它,并将其包含在@ApiResponses注释中。

0

您可以创建一个使用ApiResponses注释自定义注解。 并在方法级别使用此自定义注释。 @ApiResponses() 公共@interface CustomApiResponse {}

+0

@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @ApiResponses(值= { @ApiResponse(代码= 200,消息=“成功检索清单“), @ApiResponse(代码= 401,消息=‘您无权查看该资源’), @ApiResponse(代码= 403,消息=‘访问您尝试访问该资源被禁止’), @ApiResponse(code = 404,message =“您尝试访问的资源未找到”) }) public @interface CustomApiResponse { } –

+0

请在您的评论中编辑您的答案,并设置您的答案(Ctrl + K)以获取更多详细信息 – user7294900