如何使用 Serde 序列化具有顶级键的结构？

Question

我目前正在使用 Rocket 开发一个 Web API，它使用以下结构来响应错误：

#[derive(Serialize, Deserialize)]
pub struct ErrorResponse {
    code: u16,
    reason: &'static str,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<String>,
}

实际上，序列化这个结构会产生类似这样的json：

{
  "code": 400,
  "reason": "Bad Request"
}

我希望以这种方式对其进行序列化：

{
  "error": {
    "code": 400,
    "reason": "Bad Request"
  }
}

不使用两种不同结构的最简单方法是什么？

提前感谢您的帮助！

Answer 1

我能想到的最简单的方法是将你的结构包装在一个带有单个结构变体的 enum 中：

#[derive(Serialize, Deserialize)]
pub enum ErrorResponseWrapper {
    #[serde(rename = "error")]
    ErrorResponse {
        code: u16,
        reason: &'static str,
        #[serde(skip_serializing_if = "Option::is_none")]
        description: Option<String>,
    }
}

这很烦人的是类型和构造函数现在必须有不同的名称。 IE。如果一个函数采用ErrorResponse，它现在必须采用ErrorResponseWrapper（尽管您可能想想出一个比这更好的名称），但您必须使用ErrorResponseWrapper::ErrorResponse 变体构造这样的值。幸运的是，您至少可以将 use ErrorResponseWrapper::ErrorResponse; 添加到您的导入中。

Playground