JSON 中的 Restlet 错误响应格式

Question

我使用restlet 框架来管理项目API。似乎默认情况下错误响应是 HTML 格式的。我该如何更改它，以便默认情况下所有错误响应都是 JSON 格式？

我尝试添加一个自定义转换器，该转换器非常适合实体响应，但不适用于错误响应。

我们有 110 多个支持 application/json 的端点，所以理想情况下，我只想将默认错误设置为始终以 JSON 格式返回。默认转换器适用于所有返回实际实体的方法。

@Get("json")
@Produces("application/json")
public User represent() {
    ...
    return result;
}

但是这个方法抛出的ResourceException会返回HTML。

Answer 1

如果您确定您的服务将要生成的格式，那么您可以在类级别使用 @Produces 注释来注释您的服务类。然后，您将不需要为每种方法定义相同的内容。

此外，一旦在类级别定义了 @Produces，并且您想要更改特定方法的响应格式，那么您可以将该特定方法注释为其他格式。

试试下面的代码..

public Response represent(){
try{

}catch(Exception ex){
    return Response.status(500)
            .entity(new ExceptionMessage("500", ex.getMessage()))
            .type(MediaType.APPLICATION_JSON).
            build();
}
return Response.status(Response.Status.OK).entity(result).build();

}

并且有下面的模型类用于异常消息。

@XmlRootElement
class ExceptionMessage{
    private String statusCode;
    private String errorMessage;

    public ExceptionMessage() {
    }

    public ExceptionMessage(String statusCode, String errorMessage) {
        this.statusCode = statusCode;
        this.errorMessage = errorMessage;
    }

    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }

    public String getStatusCode() {
        return statusCode;
    }

    public void setStatusCode(String statusCode) {
        this.statusCode = statusCode;
    }

}

This is the link dedicated to Restlet.