book

Designing Web APIs with Strapi

Name: Designing Web APIs with Strapi
ISBN: 9781800560635

by Khalid Elshafie, Mozafar Haider

February 2022

Intermediate to advanced

310 pages

5h 46m

English

Packt Publishing

Read now

Unlock full access

Designing Web APIs with Strapi
ContributorsAbout the authorsAbout the reviewer
Preface
Who this book is forWhat this book coversTo get the most out of this bookDownload the example code filesUsing this repositoryFollowing along with the bookDownload the color imagesConventions usedGet in touchShare your thoughts
Section 1: Understanding Strapi
Chapter 1: An Introduction to Strapi
What is Strapi?Why use Strapi? (The benefits of Strapi)Open-source Node.jsDatabase-agnosticCustomizable (extendable)RESTful and GraphQLUsers and permissionsPreparing the development environmentInstalling Node.jsInstalling Visual Studio Code (optional)Installing YarnInstalling Docker (optional)Installing PostmanCreating a Strapi applicationOverview of the admin panelUnderstanding server scripts The develop scriptThe start scriptThe build scriptThe Strapi scriptSummary
Chapter 2: Building Our First API
Exploring the project structure of a Strapi applicationThe commands to run StrapiThe project structureUnder the hood – the components that make up StrapiDefining the API requirementsCreating our first content-type – a classroomUsing the Strapi CLI instead of the admin panelClarifying Strapi terminologyContent-types, resources, object types, and modelsInteracting with the Strapi APISetting permissionsWhat did we just create?Understanding the makeup of a Strapi APIRoutes, controllers, services, and modelsContent-types in codeSummary
Chapter 3: Strapi Content-Types
What is the Content-Type Builder plugin?Creating and managing content-typesCreating a title field Creating a slug fieldCreating a type field Creating url and contents fieldsUnderstanding relations in StrapiOne-wayOne-to-oneOne-to-manyMany-to-oneMany-to-manyMany-wayCreating a Tutorial and Classroom relationCreating a tutorial from the admin panelInteracting with the API endpoints from Postman Differences between SINGLE TYPES and COMPONENTS Creating componentsSummary
Chapter 4: An Overview of the Strapi Admin Panel
Navigating around the admin panelContent ManagerPLUGINSGENERALMarketplacePluginsSettingsManaging admin usersThe difference between Users and admin usersCreating new admin panel usersManaging admin panel rolesManaging content effectivelySearching and filtering to query our dataCustomizing the table viewCustomizing the details viewUsing the Media LibraryMedia types in API responsesSummary
Section 2: Diving Deeper into Strapi
Chapter 5: Customizing Our API
The routes – where it all startsThe default routesDisabling a core route Adding a new routeHandling routes with controllersAdding a new controller handler for our endpointControllers – it's all about contextReusing logic with Strapi servicesCommunicating with the database using the Entity Service APIReturning a unified responsePopulating relationshipsSanitizing data – hiding passwordsOverriding the default CRUD APIsTweaking database queries and responses with life cycle hooks Using hooksDRYing the hook's logic with servicesSummary
Chapter 6: Dealing with Content
Creating sample dataCleaning upSorting API contentWhat about sorting on multiple fields?Filtering API contentPaginating API contentUnder the hood – how it worksSummary

Chapter 7: Authentication and Authorization in Strapi
Understanding the difference between admin users and API usersAPI login and sign-upWhat if I want to change the JWT expiration time?What if I want to change the JWT secret?Securing API routesUnder the hood – how it worksUsing Strapi roles and permissionsCreating the Student roleCreating the Teacher roleCreating the Admin roleWhat if I want to change the default role for a new user?Working with policiesCreating a policyHonorable mention – OAuth providersSummary
Chapter 8: Using and Building Plugins
Exploring the Strapi plugin ecosystemWhat is a plugin in Strapi?Installing and using plugins from the MarketplaceInstalling the API Documentation plugin from the CLIFinding more pluginsUse case – Enabling GraphQL for our APIUse case – Sending an email from StrapiSending an email using the Email pluginPlugins and providersHooking our API to send an emailCreating our own pluginsPlugin development – frontend versus developmentBuilding our pluginUpdating the modelBuilding the Enrollments componentCreating an API tokenDisplaying enrollments in the pluginUsing Strapi Design SystemSummary
Section 3: Running Strapi in Production
Chapter 9: Production-Ready Applications
Seeding the databaseKeeping permissions in syncServing media from an S3 bucketUsing PostgreSQLTesting PostgreSQL locallySummary
Chapter 10: Deploying Strapi
Deploying to HerokuDeploying to AWS FargateStep 1 – Creating a Docker image for our APIStep 2 – Creating a Docker repository on AWS ECRStep 3 – Creating an AWS Fargate clusterTroubleshooting Cleaning upSummary
Chapter 11: Testing the Strapi API
An overview of software testingConfiguring test toolsSetting up the test environmentPreparing the database configurationPreparing the Strapi instance Writing and running testsTesting a public endpoint Testing a secure endpointSummary
Appendix: Connecting a React App to Strapi
About the React appUnderstanding the React app folder structureRunning the app
Why subscribe?
Other Books You May EnjoyPackt is searching for authors like you

Overview

Dive into the capabilities of Strapi, an open-source headless CMS built with Node.js, by learning how to design powerful and efficient web APIs from scratch. This book focuses on practical, hands-on approaches to help you leverage Strapi's tools effectively and build scalable APIs for modern applications.

What this Book will help me do

Understand the basics of Strapi and its use cases in API development.
Design and define content types in Strapi to create efficient backend APIs.
Implement authentication and authorization seamlessly within your Strapi APIs.
Deploy your Strapi applications on platforms like Heroku and AWS with confidence.
Learn best practices for maintaining and optimizing APIs for production environments.

Author(s)

None Elshafie and None Haider are seasoned technology professionals with a wealth of experience in backend development and API design. With their deep understanding of Strapi and its applications, they bring practical insights to technical concepts. Passionate about teaching and guiding developers, their writing aims to empower readers to achieve their full potential in software development.

Who is it for?

This book is ideal for JavaScript developers, be they frontend or backend, who want to excel in API development using Strapi. Familiarity with JavaScript and REST APIs will give you a jumpstart, while others will find straightforward explanations to follow along. If you're a frontend developer aiming to venture into backend technologies or an experienced dev exploring modern CMS tools, this book is for you.

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9781800560635

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills