首页 > 解决方案 > Http4s解码器如何自定义无效字段的错误消息

问题描述

我有以下代码:

 case req @ POST -> Root =>
        req
          .decode[UserCreateRequest] { decodedRequest =>

我的堆栈是 http4s + zio。

我为这个案例类添加了自定义解码器,其中有一行:

email <- Either.cond(StringValidator.isValidEmail(emailStr), Email(emailStr), DecodingFailure("email", c.history))

发布无效的 json 和无效的电子邮件返回给我:

HTTP/1.1 422 无法处理的实体内容类型:文本/纯文本;charset=UTF-8 日期:2021 年 1 月 19 日星期二 16:46:27 GMT 内容长度:29

请求正文无效。

响应代码:422(无法处理的实体);时间:681ms;内容长度:29字节

我想定制。在 http4s 代码中,我看到 InvalidMessageBodyFailure。但我在文档中找不到如何自定义此响应的任何信息。

有人可能已经试过了吗?

谢谢

编辑:

示例用户创建请求:

final case class UserCreateRequest(
    email: Email
  )

final case class Email(value: String) extends AnyVal

json请求:

{
 "email": "myemail[at]gmail.com"
}

这可以使用这样的代码来实现:

(for {
          decodedJson <- req.asJson.mapError { decodingError =>
            HttpDecodingError(cause = decodingError.getMessage)
          }
          decodedRequest <- Task.fromEither(decodedJson.as[UserCreateRequest]).mapError { decodingError =>
            HttpDecodingError(cause = decodingError.getMessage)
          }
          response <- UserService
            .createNewUser(
              decodedRequest.email
            )
            .bimap(
              error => HttpGenericError(msg = error.msg, cause = error.cause.toString),
              u => UserResponse(u.email.value)
            )
        } yield response).foldM((error: HttpError) => BadRequest(error), u => Ok(u))

但我想知道它是否可以通过一些已经完成但没有记录的http4s核心功能来简化:)

标签: scalahttp4sziohttp4s-circe

解决方案


您可以直接Status从您的 API 返回。即你可以构造一个UnprocessableEntity实例并使用这些withXXX方法来改变响应。

假设一些结构:

final case class UserCreateRequest(isValid: Boolean)

你可以做:

case req @ POST -> Root / "foo" =>
  for {
    req <- req.decodeJson[UserCreateRequest]
    resp <- if (req.isValid) Ok()
            else UnprocessableEntity().map(_.withEntity(???).withAttribute(???))
  } yield resp

推荐阅读