Changes

stoney core: REST API

1,083 bytes removed, 08:55, 30 December 2013
/* Search helper */
</pre>
(no content for now)
 
=== Search helper ===
We want to provide an omni-search/ElasticSearch style search function and the most flexible approach is by doing the search completely on the server-side.
 
Therefore we are gonna copy the leader in search and define the URL for searching this way (see [https://blog.apigee.com/detail/restful_api_design_tips_for_search]):
 
<code>https://api.example.com/v1/search?q=fluffy+dragon</code>.
 
We already have a generic [[#Filtering.2C_sorting_and_searching|full-text search]] mechanism defined for all resources. Why not use the same mechanism but apply it on the root resource (<code>https://api.example.com/v1/?q=fluffy+dragon</code>), this way we don't have to break the REST principal (method versus resource). The search will then return simple JSON objects with a type and a location URI. The actual resources on which to apply the search filter, will be defined on the server side --[[User:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 15:24, 16 December 2013 (CET)
 
Reseller search example: <code>https://api.example.com/v1/resellers/?q=fluffy+dragon</code>
=== Reseller resource ===
SLB, editor, reviewer
3,368
edits