验证和保存方案的API设计

时间:2019-05-14 10:05:03

标签: rest api

我有一个API,我们想在其中保存商业广告。在规则方面也有验证,例如不违反小时数限制,具有限制的平均持续时间等。

如果这样的验证应具有不同的端点(例如POST广告中断/验证),然后我们从UI进行验证

a。用户界面-> commercialbreaks / validation,如果通过,则用户界面会点击commercialbreaks-> POST / commercialbreaks。

b。还是我们应该有一个端点,即POST / commercialbreaks,然后在此API内部调用/ commercialbreaks / validation。

验证也需要用户输入,以便进行规则验证。如果我们去b),只要碰到POST / commercialbreaks,我们都必须传递相同的密码。

在验证之后,保存还有一个延迟,然后系统中发生了一些更改,因此我们可能需要再次验证。

这是一种更好的设计方法。另外,在这种情况下,验证会给出一条消息,提示它失败/通过,并且如果用户具有“覆盖”特权,则他将能够覆盖验证并仍然能够保存中断。在这种情况下,我们应该使用具有覆盖标志= true / false的相同端点POST / commercialbreaks。请提出建议。

1 个答案:

答案 0 :(得分:0)

您无需在第二个端点上进行验证,因为您始终希望运行验证。如果您想在用户点击保存按钮之前可视化问题,则应该进行客户端验证。然后应该是在那个端点上发生的服务器端验证。如果验证失败,请注意,您可以返回http状态400,但如有必要,还可以返回JSON对象以及有关任何补救建议的所有信息。我想,验证是一个实现设计主题,而不是API设计主题。