Hvordan å bruke
filtre
Du kan bruke filtersalternativet for å begrense dataene som er hentet fra Drupal. Filtre brukes per JSON API-samling. Du kan bruke hvilken som helst gyldig JSON API-filterforespørsel . For store datasett kan dette redusere byggetiden for applikasjonen din ved å la Gatsby hoppe over innhold du aldri vil bruke.
Som et eksempel, hvis din JSON API endepunkt ( https://live-contentacms.pantheonsite.io/api ) returnerer følgende samlinger listen, articlesog recipeser begge samlinger som kan ha et filter brukes:
{
...
links: {
articles: "https://live-contentacms.pantheonsite.io/api/articles",
recipes: "https://live-contentacms.pantheonsite.io/api/recipes",
...
}
}
For å hente bare oppskrifter med en spesifikk tag kan du gjøre noe som følgende der nøkkelen (oppskriften) er samlingen ovenfra, og verdien er filteret du vil bruke.
Noe som ville resultert i at Gatsby bruker den filtrerte samlingen https://live-contentacms.pantheonsite.io/api/recipes?filter??tags.name?…₂=British for å hente data.
Grunnleggende autent
Du kan bruke basicAuthalternativet hvis nettstedet ditt er beskyttet av basicauth. Først trenger du en måte å overføre miljøvariabler til byggeprosessen, slik at hemmeligheter og andre sikrede data ikke er forpliktet til kildekontroll. Vi anbefaler å bruke dotenvhvilke som deretter vil eksponere miljøvariabler. Les mer om dotenv og bruk av miljøvariabler her . Da kan vi bruke disse miljøvariablene og konfigurere plugin-modulen vår.
Be om overskrifter
Du kan legge til valgfrie forespørselsoverskrifter i forespørselen ved å bruke headersparam.
FÅ Params
Du kan legge til valgfrie GET-forespørselsparamenter til forespørselens url ved å bruke paramsalternativet.
Samtidige filforespørsler
Du kan bruke concurrentFileRequestsalternativet til å endre hvor mange samtidige filforespørsler som sendes til serveren / tjenesten. Dette gir nytte av hastigheten, men for mange samtidig filforespørsler kan føre til utmattelse av minne avhengig av serverens minnestørrelse, så endre med forsiktighet.
Ikke tillatte koblingstyper
Du kan bruke disallowedLinkTypesalternativet til å hoppe over koblingstyper som finnes i JSON: API-dokumenter. Som standard hopper den over selfog describedbylenker, som ikke inneholder data som kan hentes. Du kan overstyre innstillingen for å legge til flere lenketyper som skal hoppes over.
Gatsby-forhåndsvisning (eksperimentell)
Du må ha Drupal-modulen installert, mer informasjon om det her: https://www.drupal.org/project/gatsby
I konfigurasjonen av Drupal-modulen angir du oppdaterings-URL-en til forekomst-URLen til Gatsby Preview.
MERKNADER :
Dette er eksperimentell funksjon i aktiv utvikling. APIer som brukes for denne funksjonen er ennå ikke stabile - den kan gå i stykker mens vi itererer med API-design (spesielt når versjoner av gatsby-source-drupalog Gatsby Live PreviewDrupal-modulen er inkompatible).
Forhåndsvis hemmelighet
Selv om du ikke trenger å gi noen ekstra alternativer for at forhåndsvisning skal fungere, kan du gi en secretfor økt sikkerhet mellom Drupal-forekomsten og Gatsby-forhåndsvisning. Forsikre deg om at denne hemmeligheten samsvarer med det settet i Drupal Gatsby-forhåndsvisningsinnstillingene.
// In your gatsby-config.js
module.exports = {
plugins: [
{
resolve: `gatsby-source-drupal`,
options: {
baseUrl: `https://live-contentacms.pantheonsite.io/`,
secret: process.env.PREVIEW_SECRET, // optional, must match Drupal instance preview secret
},
},
],
}
Hvordan spørre
Du kan spørre noder opprettet fra Drupal slik:
{
allArticle {
edges {
node {
title
internalId
created(formatString: "DD-MMM-YYYY")
}
}
}
}
