此用例的REST API模式

时间:2017-01-23 22:49:34

标签: rest api api-design

我需要通过一个AJAX调用实现这一点,其中一个方便的辅助函数(在服务器上)可以解决这个问题,但REST的方法是什么?

我在浏览器端有一个项目列表(猫),我需要填充所有这些项目的另一个细节。

input = [list of cat ids]
output = [list of {}s which has cat ids & age]

如果我不需要关心正确的REST API,我只需要声明一个方法populate_cat_details()并通过返回JSON的GET http://example.com?method=populate_cat_details&cat_ids=1,2,3,4调用它

1 个答案:

答案 0 :(得分:1)

GET http://www.example.com/cats    -> return all cats
GET http://www.example.com/cats/:id    -> return 1 cat by id
GET http://www.example.com/cats?id=x&id=y&id=z -> return n cats matching ids
GET http://www.example.com/cats?age=2&age=3&age=4  -> return n cats matching ages 
GET http://www.example.com/cats?id=x&id=y&id=z&age=2&age=3&age=4  -> return n cats matching ids and ages

如果传递参数(如逗号分隔值ex:ids = 1,2,3

),您还有其他方法

看看这里: http://www.restapitutorial.com/lessons/restfulresourcenaming.html