chekkan / cde-platform-api

City Data Exchange's platform API

Hi there 👋🏽

I am a Software Craftsperson who is passionate about learning and community 👨🏽‍💻. I haven't done much contribution to open source but would love to.

Find me around the web:

• 🐦 Learning in public on Twitter
• 💼 Sharing updates on LinkedIn
• 🖋 Writing on chekkan.com

cde-platform-api's Issues

Restful Pagination & Filters

The recommendation is to support use of both the HTTP Range header plus querystring parameters, offset and limit.
Given support for both options, the query-string parameters should override the Range header.
http://www.restapitutorial.com/media/RESTful_Best_Practices-v1_1.pdf

Pagination

Range: items=25-49

or

?offset=0&limit=25

to return maximum of 25 items starting from 0.

The server response will include

Content-Range: 25-49/66

where 25-49 is the items returned and 66 is the number of items available in the server. It is also valid to replace the total items available (66 in this case) with an asterisk (“*”) if the number of items is unknown at response time, or if the calculation of that number is too expensive. In this case the response header would look like this:

Content-Range: items 40-65/* 

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