在Endpoint中使用oatpp::Enum作为路径参数类型的正确方法是什么？

Question

我正在使用Oat++框架(https://oatpp.io/)来构建REST API。我希望管理用户角色，并希望有一个端点来更新用户记录的单个字段-用户角色。为了实现这一点，我创建了一个端点：

ENDPOINT("PUT", "/users/{userId}/role/{role}", updateUserRole,
         PATH(oatpp::String, userId),
         PATH(oatpp::String, role))
{
  // TODO - Set user role here.
  return createResponse(Status::CODE_200, "OK");
}

现在，我想验证用户角色是否具有正确的值。具体地说，它的值属于允许值的集合。我可以使用预定义的值创建某种类型的静态集，并检查它是否包含收到的值，但我想知道是否有更好的方法来实现这一点。

我发现Oatpp有一些枚举类型，但是我找不到任何在端点中使用oatpp::Enum作为路径参数的示例。

那么，可以使用oatpp::Enum作为路径参数吗？如果是，那么正确的使用方法是什么？

提前感谢！

Answer 1

在DTO code-gen部分声明一个Enum：

ENUM(UserRoles, v_int32,
  VALUE(ADMIN, 1, "admin"), //<- you may use qualifiers here
  VALUE(GUEST, 2),
  VALUE(USER, 3)
)

声明一个端点：

ENDPOINT("PUT", "/users/{userId}/role/{role}", updateUserRole,
         PATH(oatpp::String, userId),
         PATH(oatpp::Enum<UserRoles>, role))
{
  // TODO - Set user role here.
  return createResponse(Status::CODE_200, "OK");
}

oatpp::Enum将为您完成所有验证。

有效请求：

$ curl -X PUT http://localhost:8000/users/user-1/role/GUEST
OK

无效请求：

$ curl -X PUT http://localhost:8000/users/user-1/role/SOMETHING
server=oatpp/1.1.0
code=400
description=Bad Request
message=Invalid PATH parameter 'role'. Expected type is 'oatpp::Enum<UserRoles>'

如果您想接收整数值，也可以使用oatpp::Enum<UserRoles>::AsNumber。