指导如何选择适当的 HTTP 状态码

本文提供了有关选择合适 HTTP 状态码的指导，供 API 开发人员使用。作者建议对验证失败的请求始终返回 400 状态码，因为 422 状态码适用于不同目的。文章还讨论了从软件角度区分 400 和 422 状态码的重要性，并强调支持不同的错误代码以实现重试机制的好处。

我编写了这个小 api，并且使用验证器来验证请求字段，并且在响应中传播错误而不是错误代码，我希望能够添加自定义错误消息并分配特定的状态代码。例如：如果传递了不正确的类型，我想发出消息，表明已传递了不正确的类型，状态代码将为 400，所需字段缺失将为 422，内部服务器错误将为 500。我正在努力实现这一点。任何帮助将不胜感激。

type Trade struct {
    ClientTradeId string `json:"client_trade_id" validate:"nonzero"`
    Date          int    `json:"date" validate:"nonzero, min=20010101, max=21000101"`
    Quantity      string `json:"quantity" validate:"nonzero, regexp=^[-]?[0-9]*\\.?[0-9]+$"`
    Price         string `json:"price" validate:"nonnil, nonzero, regexp=^[-]?[0-9]*\\.?[0-9]+$"`
    Ticker        string `json:"ticker" validate:"nonzero, nonnil"`
}
type InternalTrade struct {
    Id string `json:"Id" validate:"nonzero"`
    Trade *Trade `json:"Trade"`
}

type TradeSubmitted struct {

    TradeId string `json:"TradeId" validate:"nonzero"`
    ClientTradeId string `json:"clientTradeId" validate:"nonzero"`

}

type Error struct {
    Message string `json:"Message"`
}


var trades []InternalTrade
var (
    tradeValidator = validator.NewValidator()
)
func createTrade(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")

    var trade Trade
    var tradeSubmitted TradeSubmitted

    json.NewDecoder(r.Body).Decode(&trade)
    if errs := tradeValidator.Validate(trade); errs != nil {
        json.NewEncoder(w).Encode(errs)
        return

    }
    internal := InternalTrade{
        Id: strconv.Itoa(rand.Intn(1000000)),
        Trade: &trade,
    }


    tradeSubmitted.ClientTradeId = trade.ClientTradeId
    tradeSubmitted.TradeId = internal.Id

    trades = append(trades, internal)

    json.NewEncoder(w).Encode(&tradeSubmitted)

}

解决方案

恕我直言，请求验证应始终返回 400。

422 是为不同目的而设计的 - https://www.rfc-editor.org/rfc/rfc4918#section-11.2

如果您的请求未通过验证，则意味着其语法不正确。

验证成功完成后，您可以进行其他检查，然后返回 422。

但是从不同的角度来看这个问题。

区分400和422真的那么重要吗？客户端软件（而不是人类）会从中受益，这现实吗？

我在这里专注于软件，因为人们可以阅读消息，而代码对我们来说是多余的。

让我给您举一个软件对状态代码做出正确反应的示例。

可靠的系统应该支持不同的错误代码，并区分重试可以帮助传递消息的情况和重试因为总是失败而无用的情况（除非我们更改服务器代码）。通过返回 400，我们向客户端暗示重试不会有帮助。客户端可以在代码中实现分支并重试请求 500 并完成执行 400。

额外的 422 代码是否会增加任何价值？

以上就是《指导如何选择适当的 HTTP 状态码》的详细内容，更多关于的资料请关注golang学习网公众号！