How to design RESTful search/filtering? [closed]

by

The best way to implement a RESTful search is to consider the search itself to be a resource. Then you can use the POST verb because you are creating a search. You do not have to literally create something in a database in order to use a POST.

For example:

Accept: application/json
Content-Type: application/json
POST http://example.com/people/searches
{
  "terms": {
    "ssn": "123456789"
  },
  "order": { ... },
  ...
}

You are creating a search from the user’s standpoint. The implementation details of this are irrelevant. Some RESTful APIs may not even need persistence. That is an implementation detail.

More Related Contents:

  1. RESTful Authentication
  2. 400 BAD request HTTP error code meaning?
  3. What are best practices for REST nested resources?
  4. How can I handle many-to-many relationships in a RESTful API?
  5. 400 vs 422 response to POST of data
  6. Pagination in a REST web application
  7. When do I use path params vs. query params in a RESTful API?
  8. How to version REST URIs
  9. How to create REST URLs without verbs?
  10. XDebug and RESTful server using PHPStorm or POSTman
  11. REST Complex/Composite/Nested Resources [closed]
  12. What is the advantage of using REST instead of non-REST HTTP?
  13. What is REST? Slightly confused [closed]
  14. powershell invoke-restmethod multipart/form-data
  15. Transactions across REST microservices?
  16. Designing URI for current logged in user in REST applications
  17. RESTful Services – WSDL Equivalent
  18. What’s the best RESTful method to return total number of items in an object?
  19. Making a PowerShell POST request if a body param starts with ‘@’
  20. Spring 4 RestController JSON: characteristics not acceptable according to the request “accept” headers
  21. How to use object filter with softlayer rest api?
  22. Jersey with Struts2 [duplicate]
  23. REST API Authentication
  24. How to download excel (.xls) file from API in postman?
  25. Where can I find jenkins restful api reference? [closed]
  26. Flutter fetched Japanese character from server decoded wrong
  27. Websocket vs REST when sending data to server
  28. How to do a PUT request with cURL?
  29. What REST PUT/POST/DELETE calls should return by a convention?
  30. Get/post to RESTful web service

Leave a Comment