Alexandre Bodin c98089ff65 Merge branch 'master' into releases/3.2
Signed-off-by: Alexandre Bodin <bodin.alex@gmail.com>
2020-10-05 12:00:03 +02:00

293 lines
6.1 KiB
Markdown

# Getting Started with Gatsby
This integration guide is following the [Getting started guide](../getting-started/quick-start.html). We assume that you have completed [Step 8](../getting-started/quick-start.html#_8-consume-the-content-type-s-api) and therefore can consume the API by browsing this [url](http://localhost:1337/restaurants).
If you haven't gone through the getting started guide, the way you request a Strapi API with [Gatsby](https://www.gatsbyjs.org/) remains the same except that you will not fetch the same content.
### Create a Gatsby app
Create a basic Gatsby application using the [Gatsby CLI](https://www.gatsbyjs.org/docs/gatsby-cli/).
```bash
gatsby new gatsby-app
```
### Configure Gatsby
Gatsby is a [Static Site Generator](https://www.staticgen.com/) and will fetch your content from Strapi at build time. You need to configure Gatsby to communicate with your Strapi application.
```bash
yarn add gatsby-source-strapi
```
- Add the `gatsby-source-strapi` to the plugins section in the `gatsby-config.js` file:
```js
{
resolve: "gatsby-source-strapi",
options: {
apiURL: "http://localhost:1337",
contentTypes: [
"restaurant",
"category",
],
queryLimit: 1000,
},
},
```
### GET Request your collection type
Execute a `GET` request on the `restaurant` Collection Type in order to fetch all your restaurants.
Be sure that you activated the `find` permission for the `restaurant` Collection Type.
_Request_
```graphql
query {
allStrapiRestaurant {
edges {
node {
strapiId
name
description
}
}
}
}
```
_Response_
```json
{
"data": {
"allStrapiRestaurant": {
"edges": [
{
"node": {
"strapiId": 1,
"name": "Biscotte Restaurant",
"description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
}
}
]
}
}
}
```
### Example
`./src/pages/index.js`
```js
import React from 'react';
import { StaticQuery, graphql } from 'gatsby';
const query = graphql`
query {
allStrapiRestaurant {
edges {
node {
strapiId
name
description
}
}
}
}
`;
const IndexPage = () => (
<StaticQuery
query={query}
render={data => (
<ul>
{data.allStrapiRestaurant.edges.map(restaurant => (
<li key={restaurant.node.strapiId}>{restaurant.node.name}</li>
))}
</ul>
)}
/>
);
export default IndexPage;
```
Execute a `GET` request on the `category` Collection Type in order to fetch a specific category with all the associated restaurants.
Be sure that you activated the `findOne` permission for the `category` Collection Type.
_Request_
```graphql
query {
strapiCategory(strapiId: { eq: 1 }) {
strapiId
name
restaurants {
name
description
}
}
}
```
_Response_
```json
{
"data": {
"strapiCategory": {
"id": "1",
"name": "French Food",
"restaurants": [
{
"name": "Biscotte Restaurant",
"description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers."
}
]
}
},
"extensions": {}
}
```
### Example
`./src/pages/index.js`
```js
import React from 'react';
import { StaticQuery, graphql } from 'gatsby';
const query = graphql`
query {
strapiCategory(strapiId: { eq: 1 }) {
id
name
restaurants {
id
name
description
}
}
}
`;
const IndexPage = () => (
<StaticQuery
query={query}
render={data => (
<div>
<h1>{data.strapiCategory.name}</h1>
<ul>
{data.strapiCategory.restaurants.map(restaurant => (
<li key={restaurant.id}>{restaurant.name}</li>
))}
</ul>
</div>
)}
/>
);
export default IndexPage;
```
We can generate pages for each category.
- Tell Gatsby to generate a page for each category by updating the `gatsby-node.js` file with the following:
```js
exports.createPages = async ({ graphql, actions }) => {
const { createPage } = actions;
const result = await graphql(
`
{
categories: allStrapiCategory {
edges {
node {
name
}
}
}
}
`
);
if (result.errors) {
throw result.errors;
}
// Create blog articles pages.
const categories = result.data.categories.edges;
const CategoryTemplate = require.resolve('./src/templates/category.js');
categories.forEach((category, index) => {
createPage({
path: `/category/${category.node.name}`,
component: CategoryTemplate,
context: {
name: category.node.name,
},
});
});
};
```
- Create a `./src/templates/category.js` file that will display the content of each one of your category:
```js
import React from 'react';
import { graphql } from 'gatsby';
export const query = graphql`
query Category($name: String!) {
category: strapiCategory(name: { eq: $name }) {
name
restaurants {
id
name
}
}
}
`;
const Category = ({ data }) => {
const restaurants = data.category.restaurants;
const category = data.category.name;
return (
<div>
<h1>{category}</h1>
<ul>
{restaurants.map(restaurant => {
return <li key={restaurant.id}>{restaurant.name}</li>;
})}
</ul>
</div>
);
};
export default Category;
```
You can find your restaurant categories by browsing `http://localhost:8000/category/<name-of-category>`.
Feel free to do the same for your restaurants!
## Starter
- [Gatsby Blog starter](https://github.com/strapi/strapi-starter-gatsby-blog)
- [Gatsby blog starter v2](https://github.com/strapi/strapi-starter-gatsby-blog-v2)
## Conclusion
Here is how to request your Collection Types in Strapi using Gatsby.
Learn more about [GraphQL](../plugins/graphql.html).