API 命名约定,URI 中相同的资源名词
API naming Conventions, same resource noun in the URI
我正在为移动设备开发一个项目,并努力保持 API 标准,因为这将是其他人使用的 API。
在同一个资源URI中使用同一个资源名词合适吗?
例如,API 将检查特定设备是否应从我们的服务中列入黑名单:
v1.0/device/blacklist/device/
在这里使用两次device合适吗?我似乎找不到任何地方提到这是否适合 API 命名约定。
谢谢
Is it appropriate to use device twice here?
当然可以,为什么不呢? REST 不关心你使用什么拼写作为你的标识符,所以它当然不应该关心一些路径段有共同的拼写。
例如,如果您要识别二叉树中的节点,则像
这样的标识符
/tree/root/left/left/right/left/...
很好。
机器不关心你使用什么拼写;所以唯一的问题是在你的环境中它是否被人类接受;换句话说,请参阅您当地的设计指南。
我正在为移动设备开发一个项目,并努力保持 API 标准,因为这将是其他人使用的 API。 在同一个资源URI中使用同一个资源名词合适吗?
例如,API 将检查特定设备是否应从我们的服务中列入黑名单: v1.0/device/blacklist/device/
在这里使用两次device合适吗?我似乎找不到任何地方提到这是否适合 API 命名约定。 谢谢
Is it appropriate to use device twice here?
当然可以,为什么不呢? REST 不关心你使用什么拼写作为你的标识符,所以它当然不应该关心一些路径段有共同的拼写。
例如,如果您要识别二叉树中的节点,则像
这样的标识符/tree/root/left/left/right/left/...
很好。
机器不关心你使用什么拼写;所以唯一的问题是在你的环境中它是否被人类接受;换句话说,请参阅您当地的设计指南。