API命名约定,URI中的相同资源名词

时间:2017-12-18 09:56:31

标签: rest api mobile naming conventions

我正在开发一个移动设备项目,并尝试保持API标准,因为这将是其他人使用的API。 在同一资源URI中使用相同的资源名词是否合适?

例如,对于将检查特定设备是否应从我们的服务列入黑名单的API: 的 1.0 /设备/黑名单/设备/

这里两次使用设备是否合适?如果对于API命名约定这是一个合适的事情,我似乎无法找到提及的任何地方。 感谢。

1 个答案:

答案 0 :(得分:2)

  

在这里使用设备两次是否合适?

当然,为什么不呢? REST并不关心你用于标识符的拼写,所以它当然不应该关心某些路径段有共同的拼写。

例如,如果您要识别二叉树中的节点,则标识符为

/tree/root/left/left/right/left/...

罚款

机器不关心你使用什么拼写;所以唯一的问题是在你的背景下人类是否可以接受它;换句话说,请参阅您当地的设计指南。