Web服务 – 用于数据处理和方法链接的REST API

基于REST的API是基于资源的

所以看看你的第一个例子,试图将转换属性链接到资源标识符后的URL路径.

GET http：//my.api/data/123/add/10/multiply/5/

..不适合(以及复杂的动态实现,如你已经猜到的)

无国籍

REST中的无状态的想法围绕着一个包含足够信息来处理请求并提供结果的单个HTTP调用,而不返回到客户端以获取更多信息.在服务器上存储HTTP调用的结果不是状态,它是缓存.

现在,鉴于基于REST的API可能不是最适合您的使用,如果您仍然希望使用它,您可以选择：

1.使用具有常用URL操作的Querystring

您可以使用Querystring,但简化资源路径以接受单个URI上的所有转换.考虑到你的例子,不愿意存储变换的结果,这可能是你最好的选择.

GET http://my.api/data/123/transform?add=10&multiply=5

2.非RESTful使用POST

您可以使用POST请求,并利用HTTP主体发送转换参数.如果您决定进行大量处理,这将确保您不会在查询字符串上空出空间,并且还会使您的通信更加简洁.如果POST返回图像数据,则这不被认为是RESTful的.

3.使用POST RESTful

最后,如果你决定要缓存的东西,你的POST实际上可以存储转换对象(请注意,REST不会规定如何存储,内存或数据库等),可以通过Id重新获取使用GET.

选项A

POSTing to the URI creates a subordinate resource.

POST http://my.api/data/123
{add:10,multiply:5}

回报

201 Created
Location: http://my.api/data/123/edit/{uniqueid}

然后获取编辑的数据

GET http://my.api/data/123/edit/{uniqueid}

选项B

Remove the resource identifier from the URL to make it clear that you’re creating a new item,not changing the existing one. The resulting URL is also at the same level as the original one since it’s assumed it’s the same type of result.

POST http://my.api/data
{original: 123,add:10,multiply:5}

回报

201 Created
Location: http://my.api/data/{uniqueid}

然后获取编辑的数据

GET http://my.api/data/{uniqueid}