Book Image

Designing Web APIs with Strapi

By : Khalid Elshafie, Mozafar Haider
4 (1)
Book Image

Designing Web APIs with Strapi

4 (1)
By: Khalid Elshafie, Mozafar Haider

Overview of this book

Strapi is a Node.js-based, flexible, open-source headless CMS with an integrated admin panel that anyone can use and helps save API development time. APIs built with Strapi can be consumed using REST or GraphQL from any client. With this book, you'll take a hands-on approach to exploring the capabilities of the Strapi platform and creating a custom API from scratch. This book will help JavaScript developers to put their knowledge to work by guiding them through building powerful backend APIs. You'll see how to effortlessly create content structures that can be customized according to your needs, and gain insights into how to write, edit, and manage your content seamlessly with Strapi. As you progress through the chapters, you'll discover a wide range of Strapi features, as well as understand how to add complex features to the API such as user authentication, data sorting, and pagination. You'll not only learn how to find and use existing plugins from the open-source community but also build your own plugins with custom functionality with the Strapi plugin API and add them to the admin panel. Finally, you'll learn how to deploy the API to Heroku and AWS. By the end of this book, you'll be able to build powerful, scalable, and secure APIs using Strapi.
Table of Contents (17 chapters)
1
Section 1: Understanding Strapi
6
Section 2: Diving Deeper into Strapi
11
Section 3: Running Strapi in Production

Paginating API content

In the previous two sections, we were able to filter and sort API data, but we did not have control over how many records were being retrieved. In some situations, where we have a large number of records, we will want to introduce a boundary or limit to the number of records being retrieved by a single API call. Luckily, Strapi has us covered as well for such situations: it provides a pagination API parameter that we can use to limit or paginate the API results.

Important Note

Similar to the filters API parameter, the pagination API parameter can only be used with the find endpoint.

The pagination metadata is included in the API response under the meta object. By default, Strapi returns 25 records per page. To change this value, we can use the pagination[pageSize] parameter, which will allow us to control how many records we want to retrieve per page.

To better illustrate this, let's assume we have the following requirement:

As an API user...