【问题标题】:API naming Conventions, same resource noun in the URIAPI 命名约定,URI 中相同的资源名词
【发布时间】:2017-12-18 09:56:30
【问题描述】:

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

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

这里用两次设备合适吗?我似乎找不到任何地方提到这是否适合 API 命名约定。 谢谢。

【问题讨论】:

    标签: rest api mobile naming conventions


    【解决方案1】:

    这里用两次设备合适吗?

    当然,为什么不呢? REST 不关心您对标识符使用什么拼写,因此它当然不应该关心某些路径段是否具有共同的拼写。

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

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

    很好

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

    【讨论】:

      猜你喜欢
      • 2016-07-21
      • 2023-03-02
      • 2022-01-16
      • 2019-10-05
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多