仪表板的REST端点的命名约定

我有一个RESTAPI，它看起来类似于/annotations/[id]/events[id]/flights/[id]，我想创建一个仪表板来创建一个包含一些事件和航班的注释。这种性质的东西的命名惯例是什么/注释/仪表板？

/annotations/dashboard

工作正常，假设仪表板仅用于注释相关的内容

如果仪表板的功能更像一个通用主页，那么最好只使用

/dashboard

，并且只对注释相关的端点使用

/annotations/…

---

在大多数情况下，这样的事情仅仅是审美的。但是，让API端点URI根据它们的用途/相关内容而有意义确实有帮助。

REST不关心如何命名事物或如何构造URI，但重要的是返回客户端可以用来继续的链接。这些链接应具有有意义的链接关系名称，以便客户端可以确定链接的用途。通过遵循这一原则，您可以帮助将客户机与API分离，并使客户机对API中的更改更加健壮。