error-handling - 当您使用 OAuth 2.0 构建 restful 服务时，您会使用自定义错误字段还是 OAuth 2.0 的错误字段？

Question

很难解释清楚。

在构建一个 RESTful Web 服务时，通常会为错误定义两个字段:error_code 和 error_msg

当使用 OAuth2.0 with grant_type = password 时，您会看到它已经定义了这样的 2 个字段。例如， {"error":"unauthorized","error_description":"xxx"} 。拼写必须与此完全相同，因为它受 OAuth 2.0 协议(protocol)的限制。

问题是，当您将 2 组合成一个服务器端应用程序时，您通常是否只使用 OAUTH 的 {"error":"my-biz-error-code","error_description":"xxx"} biz 错误响应，或者您更愿意自己定义两个字段，例如 {"biz_err":"my-biz-error-code","biz_err_desc":"xxx"} ？

根据您的经验，哪种方法会使客户端开发更容易？

另一个(也是可选的)问题是，如果您是 swagger.io 用户，您会选择哪种方式来生成更好的文档？

Answer 1

我现在自己回答这个问题:我定义了我的 biz 错误对象，其错误字段是 oauth2 的超集。 Oauth2 的 error_description 在我的错误响应对象中被视为“开发人员的错误消息”。

公共(public)类 FoErrorResult {

@JsonProperty("error")
private String errorCode;

@JsonProperty("error_description")
private String devErrMsg;

@JsonProperty("error_description_for_user")
private String userErrMsg;

@JsonProperty("exception_id")
private String exceptionId;

}