Disclaimer You can find the updated version of this tutorial here
This tutorial is part of the « Cooking a Deliveroo clone with Next.js (React), GraphQL, Strapi and Stripe » tutorial series.
Table of contents
Note: the source code is available on GitHub.
First of all, we need to display the list of restaurants in our web app. Of course, this list is going to be managed through our API. So, we are going to start configuring it.
A Content-Type also called a model
, is a type of data. A Strapi API includes, by default, the user
Content Type. Right now, we need restaurants, so our new Content Type is going to be, as you already guessed, restaurant
(Content Types are always singular).
Here are the required steps:
Add Content Type
.restaurant
as name.Add New Field
and create the followings fields:name
with type String.description
with type Text with Rich Text Editor (in the Advanced Settings section of the modal, select Display as a WYSIWYG
).image
with type Media
.At this point, your server should have automatically restarted and a new link Restaurant
appears in the left menu.
Well done! You created your first Content-Type. The next step is to add some restaurants to your database. To do so, click on "Restaurant" in the left menu (http://localhost:1337/admin/plugins/content-manager/restaurant).
You are now in the Content Manager plugin: an auto-generated user interface which let you see and edit entries.
Let's create a restaurant:
Add New Restaurant
.Create as many restaurants as you would like to see in your apps.
Having the items in database is great. Being able to request them from an API is even better. As you already know, Strapi's mission is to create API (I have got a super secret anecdote for you: its name is coming from Bootstrap your API 😮).
When you were creating your restaurant
Content Type, Strapi created, behind the scene, a few set of files located in api/restaurant
. These files include the logic to expose a fully customisable CRUD API. The find
route is available at http://localhost:1337/restaurants. Try to visit this URL and will be surprised to be blocked by a 403 forbidden error. This is actually totally normal: Strapi APIs are secured by design.
Don't worry, making this route accessible is actually super intuitive:
Public
role.find
and findone
checkboxes of the Restaurant
section.Important: do the same thing for the authenticated
role.
Now go back to http://localhost:1337/restaurants: at this point, you should be able to see your list of restaurants.
By default, API generated with Strapi are best on REST conventions. What if I would tell you that you could transform them into GraphQL within 10 seconds?
Well, let me prove you that.
A GraphQL plugin, which will make all the work for you, is available for Strapi. Install it with the Strapi CLI:
navigate to your backend folder where strapi is installed and install graphql using the strapi install command:
1cd backend
2strapi install graphql
Or click "Marketplace" on your admin dashboard and select GraphQL
And that's it, you are done installing GraphQL.
Make sure to restart your Strapi server if it does not auto restart
#Important: ####Downgrage graphql-js dependency
With the current implementation you will receive a GraphQL error when trying to query a MongoDB _id field:
This is currently being fixed by the graphql-js maintainers but as of time of writing has not been fixed (github issue linked below).
message: "ID cannot represent value: { _bsontype: "ObjectID", id: <Buffer 5b c1 5b 8b a1 a2 92 54 65 51 88 23> }"
This is caused by a breaking change in the graphql-js update on how the ID's from a MongoDB are serialized: https://github.com/graphql/graphql-js/issues/1518.
Based on the comments it looks like the maintainers are working on a fix but as of the time of writing (10/12/2018) the fix is to downgrade your graphql package to: GraphQL 0.13.2.
The dependency package is in the /backend folder under the GraphQL plugin folder listed at: /backend/plugins/graphql/
.
1cd plugins/graphql
2npm install graphql@0.13.2 --save
Inside of your packages.json file your graphql dependency should be listed as "graphql": "0.13.2"
Until the issue is fixed if you upgrade your packages inside the server you will break the implementation.
Restart your server, go to http://localhost:1337/graphql and try this query:
1{
2 restaurants {
3 _id
4 name
5 }
6}
It looks you are going in the right direction. What if we would display these restaurants in our Next app?
Install Apollo in the frontend of our application, navigate to the /frontend
folder:
1cd ..
2cd ..
3cd ..
4cd frontend
5yarn add react-apollo next-apollo graphql gql recompose
To connect our application with GraphQL we will use Apollo and the next-apollo implementation to wrap our components in a withData HOC to give them access to make apollo data queries.
There are a couple of different approaches to implementing GraphQL into a Nextjs app, the approach we will take is extracting the Apollo logic into lib file and wrapping our components with a Higher Order Component called withData to handle the GQL queries inside each respective component.
Example repo detailing the Apollo Next.js implementation: https://github.com/adamsoffer/next-apollo-example.
Create a lib directory in the root of the project:
1mkdir lib
2cd lib
3touch apollo.js
Path: /frontend/lib/apollo.js
We will generate the list of Restaurants inside a RestaurantList file as:
1cd ..
2cd components
3
4mkdir RestaurantList
5cd RestaurantList
6touch index.js
Path: /frontend/components/RestaurantList/index.js
Now update your /pages/index.js
home route to display the Restaurant list:
Path: /frontend/pages/index.js
We will need to update our _app.js
file to wrap our application with the Apollo Provider that will enable GraphQL to make queries:
Path: /frontend/pages/_app.js
Now you should see the list of restaurants on the page.
Well done!
🍔 In the next section, you will learn how to display the list of dishes: https://blog.strapi.io/strapi-next-dishes.
Ryan is an active member of the Strapi community and he's been contributing at a very early stage by writing awesome tutorial series to help fellow Strapier grow and learn.