如何在 restful api 中验证来自 post 的数据
How validate data from post in restful api
我需要在插入数据库之前验证一些数据,为此我创建了一个小服务,该服务 return 来自实体的无效字段。它在验证单个实体时工作正常。
class EntityValidator
{
protected $validator;
public function __construct(ValidatorInterface $validator)
{
$this->validator = $validator;
}
public function validate($entity)
{
$errors = $this->validator->validate($entity);
$response = null;
if ($errors->count()) {
foreach ($errors as $error) {
$response[$error->getPropertyPath()] = $error->getMessage();
}
}
return $response;
}
}
但我一直在努力验证更复杂的问题,例如:
这是一个 restful api 端点,它在 post 的正文中接收 user_id 和百分比的 json,它将验证实体以查看它是否是与 symfony 验证器约束映射的权利。
public function create(Request $request, EntityValidator $entityValidator)
{
$data = json_decode($request->getContent(), true);
$entityExample = new EntityExample();
$entityExample
->setUserId($data['user_id'])
->setPercentage($data['percentage'])
;
$errors = $entityValidator->validate($entityExample);
// .. do other things ..
return new JsonResponse($errors);
}
但是假设我收到一个数据数组并且我打算一次插入很多行并且有一个业务逻辑说 "the sum of percentage of a user need to be 100"
public function create(Request $request, EntityValidator $entityValidator)
{
$data = json_decode($request->getContent(), true);
$totalPercentage = 0;
foreach ($data as $element) {
$entityExample = new EntityExample();
$entityExample
->setUserId($element['user_id'])
->setPercentage($element['percentage'])
;
$totalPercentage += $element['percentage'];
}
$errors = $entityValidator->validate($entityExample);
if ($totalPecentage != 100) {
$errors[] = 'Sum of percentage must be 100';
}
// .. do other things ..
return new JsonResponse($errors);
}
在控制器中保留这种业务逻辑似乎是错误的,但我不知道把它放在哪里,我应该为此创建一个服务吗?那么每个具有更复杂验证的端点都将创建一个新服务?
- 创建您的 JSON 请求负载的模型表示。一个只有 public 属性的模型。例如假设模型被称为
Sale
.
- 创建一个自定义 Validation Constraint,它将与
Sale
模型连接。在此验证中 class 您将遍历 Sale.percentage
属性 和 运行 您的验证逻辑。
- 在您的控制器中,您调用序列化程序组件和验证程序组件来验证请求。
以上各点的完整示例:
- 下面的两个链接都有模型示例,但如果您想要更多示例,请在本页中按 ctrl+f
json
http://www.inanzzz.com/index.php/posts/symfony
- Class level custom assert validation constraint in symfony
- A simple way of handling request, response and exceptions in Symfony API。复制并且不要触摸
AbstractController
。做 UserController::create
为您自己的控制器所做的事情。他在同一控制器中使用 $this->data
进行演示,但您应该将其传递给服务并在那里进行处理。
我需要在插入数据库之前验证一些数据,为此我创建了一个小服务,该服务 return 来自实体的无效字段。它在验证单个实体时工作正常。
class EntityValidator
{
protected $validator;
public function __construct(ValidatorInterface $validator)
{
$this->validator = $validator;
}
public function validate($entity)
{
$errors = $this->validator->validate($entity);
$response = null;
if ($errors->count()) {
foreach ($errors as $error) {
$response[$error->getPropertyPath()] = $error->getMessage();
}
}
return $response;
}
}
但我一直在努力验证更复杂的问题,例如: 这是一个 restful api 端点,它在 post 的正文中接收 user_id 和百分比的 json,它将验证实体以查看它是否是与 symfony 验证器约束映射的权利。
public function create(Request $request, EntityValidator $entityValidator)
{
$data = json_decode($request->getContent(), true);
$entityExample = new EntityExample();
$entityExample
->setUserId($data['user_id'])
->setPercentage($data['percentage'])
;
$errors = $entityValidator->validate($entityExample);
// .. do other things ..
return new JsonResponse($errors);
}
但是假设我收到一个数据数组并且我打算一次插入很多行并且有一个业务逻辑说 "the sum of percentage of a user need to be 100"
public function create(Request $request, EntityValidator $entityValidator)
{
$data = json_decode($request->getContent(), true);
$totalPercentage = 0;
foreach ($data as $element) {
$entityExample = new EntityExample();
$entityExample
->setUserId($element['user_id'])
->setPercentage($element['percentage'])
;
$totalPercentage += $element['percentage'];
}
$errors = $entityValidator->validate($entityExample);
if ($totalPecentage != 100) {
$errors[] = 'Sum of percentage must be 100';
}
// .. do other things ..
return new JsonResponse($errors);
}
在控制器中保留这种业务逻辑似乎是错误的,但我不知道把它放在哪里,我应该为此创建一个服务吗?那么每个具有更复杂验证的端点都将创建一个新服务?
- 创建您的 JSON 请求负载的模型表示。一个只有 public 属性的模型。例如假设模型被称为
Sale
. - 创建一个自定义 Validation Constraint,它将与
Sale
模型连接。在此验证中 class 您将遍历Sale.percentage
属性 和 运行 您的验证逻辑。 - 在您的控制器中,您调用序列化程序组件和验证程序组件来验证请求。
以上各点的完整示例:
- 下面的两个链接都有模型示例,但如果您想要更多示例,请在本页中按 ctrl+f
json
http://www.inanzzz.com/index.php/posts/symfony - Class level custom assert validation constraint in symfony
- A simple way of handling request, response and exceptions in Symfony API。复制并且不要触摸
AbstractController
。做UserController::create
为您自己的控制器所做的事情。他在同一控制器中使用$this->data
进行演示,但您应该将其传递给服务并在那里进行处理。