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

时间:2018-08-21 19:07:32

标签: rest

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

1 个答案:

答案 0 :(得分:0)

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

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

在大多数情况下,诸如此类的事情仅仅是审美。但是,根据它们的用途/相关性,使API端点URI确实有意义。