API Design

[rain1024]

Querying, Filtering and Pagination

Filtering and Sorting Results

• Filtering

GET http://www.example.com/users?filter="name::todd|city::denver|title::grand poobah”

• Sorting

GET http://www.example.com/users?sort=last_name|first_name|-hire_date

References

• Developer.github.com, (2014). Search | GitHub API. [online] Available at: https://developer.github.com/v3/search/ [Accessed 24 Jun. 2014].
• Developers.google.com, (2014). Google APIs Explorer. [online] Available at: https://developers.google.com/apis-explorer/ [Accessed 24 Jun. 2014].
• Apigee.com, (2014). Enterprise API Management | Digital Strategy | App Services | Apigee. [online] Available at: http://apigee.com [Accessed 24 Jun. 2014].
• REST API Resources
  • RESTful Service Best Practices
• How to Design a Good API & Why it Matters
• Developers.google.com, (2014). More Complex Search API Queries - Google Developers Academy — Google Developers. [online] Available at: https://developers.google.com/appengine/training/fts_adv/lesson1 [Accessed 24 Jun. 2014].