GetAllResource
?search
FindResourceByID
CreateResource
UpdateResource
DeleteResource
http://apiato.develop/v1/path/to/resource
通过其唯一标识符(ID)查找单个Car:
GET http://www.api.apiato.develop/v1/cars/123
获取所有汽车:
GET http://www.api.apiato.develop/v1/cars
通过一个或多个字段查找/搜索汽车:
GET http://www.api.apiato.develop/v1/cars?search=maker:mercedes
GET http://www.api.apiato.develop/v1/cars?search=maker:mercedes;color:white
订单和排序查询结果:
GET http://www.api.apiato.develop/v1/cars?orderBy=created_at&sortedBy=desc
GET http://www.api.apiato.develop/v1/cars?search=maker:mercedes&orderBy=created_at&sortedBy=desc
指定可选字段:
GET http://www.api.apiato.develop/v1/cars?filter=id;name;status
GET http://www.api.apiato.develop/v1/cars/123?filter=id;name;status
获取属于汽车的所有驱动程序:
GET http://www.api.apiato.develop/v1/cars/123/drivers
GET http://www.api.apiato.develop/v1/cars/123/drivers/123/addresses
包含与汽车响应的驱动程序对象关系:
GET http://www.api.apiato.develop/v1/cars/123?include=drivers
GET http://www.api.apiato.develop/v1/cars/123?include=drivers,owner
添加新车:
POST http://www.api.apiato.develop/v1/cars
添加新的驱动程序到汽车:
POST http://www.api.apiato.develop/v1/cars/123/drivers
不要使用GET改变状态; 防止Googlebot破坏您的数据。并尽可能使用GET。
除非您要更新整个资源,否则请勿使用PUT。除非你也可以在同一个URI上合法地进行GET。
不要使用POST来检索长期存在或可能合理缓存的信息。
不要执行PUT不是幂等的操作。
除非输入很大,否则请使用GET进行计算等操作,在这种情况下使用POST。
如有疑问,请优先使用POST而不是PUT。
每当你必须做一些类似RPC的事情时,请使用POST。
将PUT用于较大或分层的资源类。
使用DELETE优先于POST以删除资源。