REST Api:为资源建模前驱端点

时间:2017-03-20 18:54:31

标签: java spring rest

我在努力定义REST Api:

我正在为事务系统建模Api:现在我已经为事务资源定义了一些端点。我的终点是:

POST 
/transactions

GET
/transactions/{id}

GET
/transactions

我想添加一个新的端点,用于在特定日期之前将前10个事务转移到某个事务。

我已将端点定义为:

1.  GET
/transactions/previous10?start={TxId}&before={date}

之前,我希望它像这样定义:

2. GET
/transactions?start={TxId}&before={date}&prev=10

但每当完成GET on / transactions时,我必须查找查询参数以查看它们是否已设置(可能应该这样做)。

哪个在语义上更正确1,2或其他解决方案?

我正在使用spring boot和java。

1 个答案:

答案 0 :(得分:1)

您可以使用替代API

/transaction?offset={TxId}&date={date}&before=true&limit=10

这里

offset标识特定记录

date是条件日期默认为当前日期

before条件默认值为false

limit是记录数

实施例

/transaction?offset=20&date=2017-03-21&before=true&limit=10

<强>解释

将来您需要after特定的date记录,只需添加after=true,这就是灵活的服务

这是我对任何欢迎的变化的理解

Read more about REST best practices