These are the words that I had to mutter quite a few times in my career, at the dissatisfaction of how pagination had been implemented on several projects. Still, that dissatisfaction is nothing compared to how I feel when I occasionally had to ask “why is this API not paginated..?” So, taking a break from my usual Serverless ramblings, let’s talk about pagination :-) Unidirectional and Bidirectional Pagination Generally speaking, I see two common types of paginations: simple, unidirectional, paging through a static set of results that are too long or inefficient to return in one go — e.g. list of twitter followers, or list of Google search results bidirectional paging through a feed or stream of some sorts where new results can be added after you received the first page of results — e.g. your twitter timeline, or notifications Avoid leaky abstraction A common mistake I see is that the paginated API requires the caller to provide the “key” it uses to sort through the results, which creates a leaky abstraction. The caller must then understand the underlying mechanism the service uses to page its results — e.g. by timestamp, or alphabetical order. DynamoDB’s API is a good example of this. To page through the query results, the caller must specify the in subsequent requests. However, the service does return the in the response too. Query ExclusiveStartKey LastEvaluatedKey So, in practice, you can treat the as a token, or cursor, which you simply pass on in the next request. Except, it’s not just a token, it’s an actual sort key in the table, and the attribute names already gave the implementation details away anyway. almost LastEvaluatedKey DynamoDB On its own, this is not a big deal. However, it often has the unfortunately knock-on effect of encouraging application developers to build their application level paginations on top of this implementation detail. Except this time around, they’re not returning the in the response and the client is now responsible for tracking that piece of information. LastEvaluatedKey Congratulations, the underlying mechanic your database uses to support pagination has now leaked all the way to your front end! Make paging intent explicit and consistent Another common trend I see is that you have to send the same request parameters to the paginated API over and over, for example: max no. of results per page the direction of pagination (if bidirectional) the original query (in ’s case, this includes a no. of attributes such as , , and ) DynamoDB FilterExpression KeyConditionExpression ProjectionExpression IndexName I won’t call this one a mistake as it is by design, but more often than not it strikes me as a instead. sometimes consequence of lack of design In all the paginated APIs I have encountered, the intended behaviour is always to fetch the next for a query, not to start a different query midway through. That just wouldn’t make sense, and you probably can’t even call that pagination, more like navigation! I mean, set of results when was the last time you start a DynamoDB query, and then have to change any of the request parameters midway through paginating through the results? That said, there are legitimate reasons for changing the of pagination from a previously received page. More on this when we discuss bidirectional paging further down the article. direction Unidirectional paging with cursor For unidirectional pagination, my preferred approach is to use a simple cursor. The important detail here is to . make the **cursor** meaningless As far as the client is concerned, it’s just a blob the server returns in the response . The client shouldn’t be able to derive any implementation details from it, and the only thing it can to do with this is to send it along in the next request. when there are more results to fetch afford cursor fig. 1 — flow of request & responses for a series of paginated requests But how does the API know where to start fetching the next page from? A simple way to do this is: create a JSON object to capture the data needed to fetch next page — e.g. if you’re using DynamoDB, then this can be the request object for the next page (including the ) ExclusiveStartKey base64 encode the JSON string return the base64 blob as cursor When we receive the request to fetch the next page, we can apply the reverse process to get back the request object we created earlier. Isn’t that gonna leak even more information — e.g. that you’re using DynamoDB, the table name, the schema, etc. — if someone just base64 decode your blob? Absolutely, which is why you might also choose to the JSON first. You also don’t have to use the DynamoDB request as base. encrypt query Notice in both and the client only sends the in the subsequent requests? fig. 1 fig. 2 cursor . This is by design As I mentioned earlier, the client has already told us the query in the first request, the pagination mechanism should provide a way for fetching subsequent pages of the results. only Which, to me, means it should not any other behaviour (there is that word again, to see how the idea of applies to API design) and therefore do not require any other information besides the from the previous response. afford read here affordance cursor This in turn, means we need to capture the original query, or intent, in the so we can construct the corresponding DynamoDB request. Or, we could just capture the actual DynamoDB request in the which seems like a simple, practical solution here. cursor cursor fig. 2 — interaction between client, API and DynamoDB Bidirectional paging with cursor(s) With bidirectional paging, you need to be able to page forward in time (when new tweets are added to your timeline) as well as backward (to fetch older tweets). So a simple string would no longer suffice, instead we need 2 cursors, one for each direction, for example… cursor {"before": "ThlNjc5MjUwNDMzMA...","after": "ADfaU5ODFmMWRiYQ..."} Additionally, when paging forward, even when there are no more results right now we still have to return a cursor as new results can be added to the feed later. So we should also include a pair of boolean flags in the response. {"before": "ThlNjc5MjUwNDMzMA...","hasBefore": true,"after": "ADfaU5ODFmMWRiYQ...","hasAfter": true} When the client pages forward in time and receives as then it knows there are no more results available right now. It can therefore stop fetch the next page of results, and be more passive and only poll for new results periodically. hasAfter false actively Let’s run through a simple example, imagine if you’re fetching the tweets in your timeline where the API would return the latest tweets first. fig. 3 — paginate backward in time to fetch older data the client makes a first request API responds with a object, is because the API has responded with the latest results, but is as there are older results available cursor hasAfter false hasBefore true the client makes a second request and passes the cursor in the request, making its intention clear and unambiguous only before API responds with another object where this time both and are given that we’re right in the middle of this stream of results cursor hasBefore hasAfter true the client makes a third and last request, again passing only the cursor received from the previous response before API responds with a object where is because we have now received the oldest result available cursor hasBefore false Ok, now let’s run through another example, this time we’ll page forward in time instead. fig. 4 — paginate forward in time to fetch newer data the client makes a first request API responds with a object, is because the API has responded with the latest results, but is as there are older results available cursor hasAfter false hasBefore true some time has passed, and more results have become available the client makes a second request, and passes the cursor in the request, making its intention clear and unambiguous only after API responds with the newer results that the client has not received already, and is as these are the latest results available at this moment in time; should the client page backward (in time) from this response then it’ll receive the same results as the first response from the API only cursor.hasAfter false Now, let’s circle back to what I mentioned earlier regarding the occasional need to change direction midway through pagination. The reason we need pagination is because it’s often impractical, inefficient and in some cases impossible to return all available results for a query — e.g. at the time of writing Katy Perry has 108M Twitter followers, trying to retrieve all her followers in one request-response cycle would have crashed both the server and the client app. Besides limiting how much data can be returned in one request-response cycle, we also need to . place a upper bound on how much data the client app would cache in order to protect the user experience and prevent the client app from crashing That means, at some point, as the user keeps scrolling through older tweets, the client would need to start dropping data it has already fetched or risk running out of memory. Which means, when the user scrolls back up to see the latest tweets, the client would need to re-fetch pages that had been dropped and hence reversing the original direction of the pagination. Fortunately, the scheme outlined above is flexible enough and allows you to do just that. Every page of results has an associated that allows you to fetch the next page in either direction. So, in the case where you need to re-fetch a dropped page, it’s as simple as making a paginated request with the cursor of the latest page you have cached. cursor after Dealing with “gaps” Staying with the Twitter example. If you open up the Twitter mobile app after some time, you’ll see the tweets that has already been cached but the app also recognizes that a lot of time has passed that it’s not feasible to paginate from the cached data all the way to the latest. Instead, the client would fetch the latest tweets with a non-paginated request. As you scroll down, the client automatically fetch older pages as per and gradually fill in the gap until it joins up with the cached data. can fig. 3 The behaviour of the Twitter mobile app has changed over time, and another tactic I have seen is to place a visual (clickable) marker for the missing tweets in the timeline. This makes it an explicit action by the user to start paging through older tweets to fill in the gap. So there you have it, a simple and effective way to implement both unidirectional and bidirectional paginated APIs, hope you have found it useful! Hi, my name is . I’m an and the author of . I have run production workload at scale in AWS for nearly 10 years and I have been an architect or principal engineer with a variety of industries ranging from banking, e-commerce, sports streaming to mobile gaming. I currently work as an independent consultant focused on AWS and serverless. Yan Cui AWS Serverless Hero Production-Ready Serverless You can contact me via , and . Email Twitter LinkedIn Check out my new course, . Complete Guide to AWS Step Functions In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. Including basic concepts, HTTP and event triggers, activities, design patterns and best practices. Get your copy . here Come learn about operational for AWS Lambda: CI/CD, testing & debugging functions locally, logging, monitoring, distributed tracing, canary deployments, config management, authentication & authorization, VPC, security, error handling, and more. BEST PRACTICES You can also get off the face price with the code . 40% ytcui Get your copy . here

Flow

Amazon

Fetch

Google

Twitter

7 things I learnt from one of the best startups you’ll find

AWS Lambda — how best to manage shared code and shared infrastructure

Ask me for help about serverless

Read My Stories

Too Long; Didn't Read

“Guys, we’re doing pagination wrong…”

“Guys, we’re doing pagination wrong…”

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

6 Tips To Scale an AppSync Project To 200+ Resolvers That Will Blow Your Mind

100 Days of AI Day 1: From Newsletter to Podcast, Leveraging AI for Audio Transformation

10 Threats to an Open API Ecosystem

10 Indications That You Should Invest in Automation Via APIs

10 Best Practices for Securing Your API

The Noonification: Getting Your API Into Production (10/28/2022)

6 Tips To Scale an AppSync Project To 200+ Resolvers That Will Blow Your Mind

100 Days of AI Day 1: From Newsletter to Podcast, Leveraging AI for Audio Transformation

10 Threats to an Open API Ecosystem

10 Indications That You Should Invest in Automation Via APIs

10 Best Practices for Securing Your API

The Noonification: Getting Your API Into Production (10/28/2022)

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps