REST api pagination: make page-size a parameter (configurable from outside)

rest restapi
manuel aldana picture manuel aldana · Jan 6, 2010 · Viewed 12.7k times · Source

we are having a search/list-resource:

http://xxxx/users/?page=1

Internally the page-size is static and returns 20 items. The user can move forward by increasing the page number. But to be more flexible we are now thinking also to expose the size of a page:

http://xxxx/users/?page=1&size=20

As such this is flexible as the client can now decide network-calls vs. size of response, when searching. Of course this has the drawback that the server could be hit hard either by accident or maliciosly on purpose: http://xxxx/users/?page=1&size=1000000

For robustness the solution could be to configure an upper limit of page size (e.g. 100) and when it is exceeded either represent an error response or a HTTP redirect to the URL with highest possible page-size parameter.

What do you think?

Answer

Nate picture Nate · Jan 6, 2010

Personally, I would simply document a maximum page size, and anything larger than that is simply treated as the maximum.

Related questions

What is a good way to transfer binary data to a HTTP REST API service?

We are extending our HTTP REST API to allow clients to upload picture (for the purpose of this question, assuming binary data). So far we have only allowed simply strings in our API parameters. What is a good way to …

Read More
Python post request with Bearer token

Im trying to make a script that post data on REST service together with Bearer token. Here is working PHP example: $postData = array( 'app' => 'aaaa' ); $ch = curl_init($apiUrl); curl_setopt_array($ch, array( CURLOPT_HTTPHEADER, ['Authorization: Bearer '.$…

Read More
Which HTTP response code for "This email is already registered"?

I'm creating a RESTful API for creating users that enforces unique email addresses: Successful POST /users: HTTP 201 Created If I POST the same email address again, what should the response code be? Is 409 Conflict the appropriate response code?

Read More