仪表板的 REST 终结点的命名约定



我有一个 REST api,看起来类似于/annotations/[id]/events[id]/flights/[id],我想创建一个仪表板来创建包含一定数量事件和航班的注释。 这种性质的东西的命名约定是什么?/注释/仪表板?

/annotations/dashboard工作正常,假设仪表板仅用于与注释相关的内容。

如果仪表板的功能更像是常规主页,则最好只使用/dashboard,并且仅将/annotations/...用于与注释相关的终结点。

在大多数情况下,这样的事情只是美学上的。但是,拥有基于其用途/相关内容的有意义的 API 终结点 URI 确实会有所帮助。

最新更新