为进程构建API的正确RESTful方法是什么,这是另一个进程的一部分?

时间:2018-06-14 13:10:26

标签: rest restful-architecture restful-url

我有增值税登记程序,一旦完成,用户将进行增值税电子申请流程。

我的增值税API如下所示:

/api/vat

现在电子归档是增值税流程的一部分,因此在API下面有意义并且符合REST API标准:

api/vat/efiling/transactions  //get latest transactions for efiling process 

除此之外,如果有人能够列出在设计API时有用的一些要点,将会非常有用。

1 个答案:

答案 0 :(得分:1)

一旦您谈论的是URI设计而不是API设计本身,则必须意识到REST并不关心它。 这是一个误解。

干净的URI可能是可取的,但在REST体系结构样式中不是必需的,这在Fielding论文的chapter 5中进行了定义。


无论如何,我认为您可能缺少增值税标识符。像这样:

/api/vat/{id}/efiling/transactions

请访问Vinay Sahni的article,了解设计API的一些见识。