Saiba como usar o GraphQL com o AEM para fornecer conteúdo em headless, explorando exemplos de conteúdo e consultas.
Esta página deve ser lida junto com:
Para começar a usar consultas GraphQL e saber como elas funcionam com Fragmentos de conteúdo do AEM, seria de ajuda examinar alguns exemplos práticos.
Para isso, consulte:
E alguns exemplos de consultas GraphQL, com base no exemplo de estrutura de fragmento de conteúdo (modelos de fragmento de conteúdo e fragmentos de conteúdo relacionados).
Veja esses exemplos de consultas para obter ilustrações de como criar consultas, e veja também os exemplos de resultados.
Dependendo do seu caso, você pode acessar diretamente a Interface GraphiQL incluída na API GraphQL do AEM para enviar e testar consultas.
É possível acessar o editor de consultas por meio de:
http://localhost:4502/aem/graphiql.html
Os exemplos de consultas são baseados no Exemplo de estrutura de Fragmento de conteúdo para uso com o GraphQL
Isso retornará todos os types
para todos os esquemas disponíveis.
Exemplo de consulta
{
__schema {
types {
name
description
}
}
}
Exemplo de resultado
{
"data": {
"__schema": {
"types": [
{
"name": "AdventureModel",
"description": null
},
{
"name": "AdventureModelArrayFilter",
"description": null
},
{
"name": "AdventureModelFilter",
"description": null
},
{
"name": "AdventureModelResult",
"description": null
},
{
"name": "AdventureModelResults",
"description": null
},
{
"name": "AllFragmentModels",
"description": null
},
{
"name": "ArchiveRef",
"description": null
},
{
"name": "ArrayMode",
"description": null
},
{
"name": "ArticleModel",
"description": null
},
...more results...
{
"name": "__EnumValue",
"description": null
},
{
"name": "__Field",
"description": null
},
{
"name": "__InputValue",
"description": null
},
{
"name": "__Schema",
"description": "A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations."
},
{
"name": "__Type",
"description": null
},
{
"name": "__TypeKind",
"description": "An enum describing what kind of type a given __Type is"
}
]
}
}
}
Para recuperar todas as informações sobre todas as cidades, você pode usar essa consulta básica:
Exemplo de consulta
{
cityList {
items
}
}
Quando executada, o sistema expandirá automaticamente a consulta para incluir todos os campos:
{
cityList {
items {
_path
name
country
population
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"_path": "/content/dam/sample-content-fragments/cities/basel",
"name": "Basel",
"country": "Switzerland",
"population": 172258
},
{
"_path": "/content/dam/sample-content-fragments/cities/berlin",
"name": "Berlin",
"country": "Germany",
"population": 3669491
},
{
"_path": "/content/dam/sample-content-fragments/cities/bucharest",
"name": "Bucharest",
"country": "Romania",
"population": 1821000
},
{
"_path": "/content/dam/sample-content-fragments/cities/san-francisco",
"name": "San Francisco",
"country": "USA",
"population": 883306
},
{
"_path": "/content/dam/sample-content-fragments/cities/san-jose",
"name": "San Jose",
"country": "USA",
"population": 1026350
},
{
"_path": "/content/dam/sample-content-fragments/cities/stuttgart",
"name": "Stuttgart",
"country": "Germany",
"population": 634830
},
{
"_path": "/content/dam/sample-content-fragments/cities/zurich",
"name": "Zurich",
"country": "Switzerland",
"population": 415367
}
]
}
}
}
Esta é uma consulta simples para retornar o name
de todas as entradas no esquemacity
.
Exemplo de consulta
query {
cityList {
items {
name
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"name": "Basel"
},
{
"name": "Berlin"
},
{
"name": "Bucharest"
},
{
"name": "San Francisco"
},
{
"name": "San Jose"
},
{
"name": "Stuttgart"
},
{
"name": "Zurich"
}
]
}
}
}
Esta é uma consulta para retornar os detalhes de uma única entrada de fragmento em um local específico no repositório.
Exemplo de consulta
{
cityByPath (_path: "/content/dam/sample-content-fragments/cities/berlin") {
item {
_path
name
country
population
categories
}
}
}
Exemplo de resultados
{
"data": {
"cityByPath": {
"item": {
"_path": "/content/dam/sample-content-fragments/cities/berlin",
"name": "Berlin",
"country": "Germany",
"population": 3669491,
"categories": [
"city:capital",
"city:emea"
]
}
}
}
}
Se você criar uma nova variação chamada "Centro de Berlim" (berlin_centre
), para a city
Berlim, use uma consulta para retornar detalhes da variação.
Exemplo de consulta
{
cityList (variation: "berlin_center") {
items {
_path
name
country
population
categories
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"_path": "/content/dam/sample-content-fragments/cities/berlin",
"name": "Berlin",
"country": "Germany",
"population": 3669491,
"categories": [
"city:capital",
"city:emea"
]
}
]
}
}
}
Usando a estrutura dos fragmentos aninhados, essa consulta retorna os detalhes completos do CEO de uma empresa e de todos os funcionários dela.
Exemplo de consulta
query {
companyList {
items {
name
ceo {
_path
name
firstName
awards {
id
title
}
}
employees {
name
firstName
awards {
id
title
}
}
}
}
}
Exemplo de resultados
{
"data": {
"companyList": {
"items": [
{
"name": "Apple Inc.",
"ceo": {
"_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
"name": "Jobs",
"firstName": "Steve",
"awards": []
},
"employees": [
{
"name": "Marsh",
"firstName": "Duke",
"awards": []
},
{
"name": "Caulfield",
"firstName": "Max",
"awards": [
{
"id": "GB",
"title": "Gameblitz"
}
]
}
]
},
{
"name": "Little Pony, Inc.",
"ceo": {
"_path": "/content/dam/sample-content-fragments/persons/adam-smith",
"name": "Smith",
"firstName": "Adam",
"awards": []
},
"employees": [
{
"name": "Croft",
"firstName": "Lara",
"awards": [
{
"id": "GS",
"title": "Gamestar"
}
]
},
{
"name": "Slade",
"firstName": "Cutter",
"awards": [
{
"id": "GB",
"title": "Gameblitz"
},
{
"id": "GS",
"title": "Gamestar"
}
]
}
]
},
{
"name": "NextStep Inc.",
"ceo": {
"_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
"name": "Jobs",
"firstName": "Steve",
"awards": []
},
"employees": [
{
"name": "Smith",
"firstName": "Joe",
"awards": []
},
{
"name": "Lincoln",
"firstName": "Abraham",
"awards": []
}
]
}
]
}
}
}
Isso filtrará todas as persons
para qualquer uma que tenha o nome Jobs
ou Smith
.
Exemplo de consulta
query {
personList(filter: {
name: {
_logOp: OR
_expressions: [
{
value: "Jobs"
},
{
value: "Smith"
}
]
}
}) {
items {
name
firstName
}
}
}
Exemplo de resultados
{
"data": {
"personList": {
"items": [
{
"name": "Smith",
"firstName": "Adam"
},
{
"name": "Smith",
"firstName": "Joe"
},
{
"name": "Jobs",
"firstName": "Steve"
}
]
}
}
}
Isso filtrará todas as persons
para qualquer uma que tenha o nome Jobs
ou Smith
.
Exemplo de consulta
query {
personList(filter: {
name: {
_expressions: [
{
value: "Jobs"
_operator: EQUALS_NOT
}
]
}
}) {
items {
name
firstName
}
}
}
Exemplo de resultados
{
"data": {
"personList": {
"items": [
{
"name": "Lincoln",
"firstName": "Abraham"
},
{
"name": "Smith",
"firstName": "Adam"
},
{
"name": "Slade",
"firstName": "Cutter"
},
{
"name": "Marsh",
"firstName": "Duke"
},
{
"name": "Smith",
"firstName": "Joe"
},
{
"name": "Croft",
"firstName": "Lara"
},
{
"name": "Caulfield",
"firstName": "Max"
}
]
}
}
}
_path
comece com um prefixo específicoTodas as adventures
em que o _path
comece com um prefixo específico (/content/dam/wknd/en/adventures/cycling
).
Exemplo de consulta
query {
adventureList(
filter: {
_path: {
_expressions: [
{
value: "/content/dam/wknd/en/adventures/cycling"
_operator: STARTS_WITH
}]
}
})
{
items {
_path
}
}
}
Exemplo de resultados
{
"data": {
"adventureList": {
"items": [
{
"_path": "/content/dam/wknd/en/adventures/cycling-southern-utah/cycling-southern-utah"
},
{
"_path": "/content/dam/wknd/en/adventures/cycling-tuscany/cycling-tuscany"
}
]
}
}
}
Aqui, uma combinação de campos é filtrada. Um AND
(implícito) é usado para selecionar o intervalo population
, enquanto um OR
(explícito) é usado para selecionar as cidades necessárias.
Exemplo de consulta
query {
cityList(filter: {
population: {
_expressions: [
{
value: 400000
_operator: GREATER_EQUAL
}, {
value: 1000000
_operator: LOWER
}
]
},
country: {
_logOp: OR
_expressions: [
{
value: "Germany"
}, {
value: "Switzerland"
}
]
}
}) {
items {
name
population
country
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"name": "Stuttgart",
"population": 634830,
"country": "Germany"
},
{
"name": "Zurich",
"population": 415367,
"country": "Switzerland"
}
]
}
}
}
Esta consulta interroga todas as cidades que tenham SAN
no nome, podendo ser maiúsculas ou minúsculas.
Exemplo de consulta
query {
cityList(filter: {
name: {
_expressions: [
{
value: "SAN"
_operator: CONTAINS
_ignoreCase: true
}
]
}
}) {
items {
name
population
country
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"name": "San Francisco",
"population": 883306,
"country": "USA"
},
{
"name": "San Jose",
"population": 1026350,
"country": "USA"
}
]
}
}
}
Essa consulta filtra em uma matriz com um item (city:na
) que deve ocorrer pelo menos uma vez.
Exemplo de consulta
query {
cityList(filter: {
categories: {
_expressions: [
{
value: "city:na"
_apply: AT_LEAST_ONCE
}
]
}
}) {
items {
name
population
country
categories
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"name": "San Francisco",
"population": 883306,
"country": "USA",
"categories": [
"city:beach",
"city:na"
]
},
{
"name": "San Jose",
"population": 1026350,
"country": "USA",
"categories": [
"city:na"
]
}
]
}
}
}
Essa consulta filtra em um valor de matriz exato.
Exemplo de consulta
query {
cityList(filter: {
categories: {
_expressions: [
{
values: [
"city:beach",
"city:na"
]
}
]
}
}) {
items {
name
population
country
categories
}
}
}
Exemplo de resultados
{
"data": {
"cityList": {
"items": [
{
"name": "San Francisco",
"population": 883306,
"country": "USA",
"categories": [
"city:beach",
"city:na"
]
}
]
}
}
}
Esta consulta ilustra a filtragem de qualquer person
de name
"Smith", retornando informações de dois fragmentos aninhados - company
e employee
.
Exemplo de consulta
query {
companyList(filter: {
employees: {
_match: {
name: {
_expressions: [
{
value: "Smith"
}
]
}
}
}
}) {
items {
name
ceo {
name
firstName
}
employees {
name
firstName
}
}
}
}
Exemplo de resultados
{
"data": {
"companyList": {
"items": [
{
"name": "NextStep Inc.",
"ceo": {
"name": "Jobs",
"firstName": "Steve"
},
"employees": [
{
"name": "Smith",
"firstName": "Joe"
},
{
"name": "Lincoln",
"firstName": "Abraham"
}
]
}
]
}
}
}
Esta consulta ilustra a filtragem entre três fragmentos aninhados - company
, employee
e award
.
Exemplo de consulta
query {
companyList(filter: {
employees: {
_apply: ALL
_match: {
awards: {
_match: {
id: {
_expressions: [
{
value: "GS"
_operator:EQUALS
}
]
}
}
}
}
}
}) {
items {
name
ceo {
name
firstName
}
employees {
name
firstName
awards {
id
title
}
}
}
}
}
Exemplo de resultados
{
"data": {
"companyList": {
"items": [
{
"name": "Little Pony, Inc.",
"ceo": {
"name": "Smith",
"firstName": "Adam"
},
"employees": [
{
"name": "Croft",
"firstName": "Lara",
"awards": [
{
"id": "GS",
"title": "Gamestar"
}
]
},
{
"name": "Slade",
"firstName": "Cutter",
"awards": [
{
"id": "GB",
"title": "Gameblitz"
},
{
"id": "GS",
"title": "Gamestar"
}
]
}
]
}
]
}
}
}
Esta consulta ilustra a filtragem entre três fragmentos aninhados - company
, employee
e award
.
Exemplo de consulta
query {
awardList(filter: {
id: {
_expressions: [
{
value:"GB"
}
]
}
}) {
items {
_metadata {
stringMetadata {
name,
value
}
}
id
title
}
}
}
Exemplo de resultados
{
"data": {
"awardList": {
"items": [
{
"_metadata": {
"stringMetadata": [
{
"name": "title",
"value": "Gameblitz Award"
},
{
"name": "description",
"value": ""
}
]
},
"id": "GB",
"title": "Gameblitz"
}
]
}
}
}
Esses exemplos de consultas são baseadas no projeto WKND. Isso tem:
Modelos de fragmentos de conteúdo disponíveis em:
http://<hostname>:<port>/libs/dam/cfm/models/console/content/models.html/conf/wknd
Fragmentos de conteúdo (e outro conteúdo) disponíveis em:
http://<hostname>:<port>/assets.html/content/dam/wknd/en
http://<hostname>:<port>/assets.html/content/dam/wknd-shared/en
Como os resultados podem ser extensos, eles não são reproduzidos aqui.
Este exemplo de consulta interroga:
article
_path
e as propriedades do authorFragment
.Exemplo de consulta
{
articleList {
items {
_path
authorFragment {
_path
firstName
lastName
birthDay
}
}
}
}
Esta consulta interroga:
adventure
Exemplo de consulta
{
adventureList {
items {
_path,
_metadata {
stringMetadata {
name,
value
}
stringArrayMetadata {
name,
value
}
intMetadata {
name,
value
}
intArrayMetadata {
name,
value
}
floatMetadata {
name,
value
}
floatArrayMetadata {
name,
value
}
booleanMetadata {
name,
value
}
booleanArrayMetadata {
name,
value
}
calendarMetadata {
name,
value
}
calendarArrayMetadata {
name,
value
}
}
}
}
}
Este exemplo de consulta interroga:
article
em um caminho específico
Exemplo de consulta
{
articleByPath(_path: "/content/dam/wknd-shared/en/magazine/alaska-adventure/alaskan-adventures") {
item {
_path
authorFragment {
_path
firstName
lastName
birthDay
}
main {
html
markdown
plaintext
json
}
}
}
}
Este exemplo de consulta interroga:
Exemplo de consulta
{
adventureByPath(_path: "/content/dam/wknd-shared/en/magazine/western-australia/western-australia-by-camper-van") {
item {
_path
title
_model {
_path
title
}
}
}
}
Esta consulta interroga:
article
em um caminho específico
O campo referencearticle
tem o tipo de dados fragment-reference
.
Exemplo de consulta
{
adventureByPath(_path: "/content/dam/wknd-shared/en/magazine/western-australia/western-australia-by-camper-van") {
item {
_path
title
_model {
_path
title
}
}
}
}
Esta consulta interroga:
bookmark
Article
O campo fragments
tem o tipo de dados fragment-reference
, com o modelo Article
selecionado. A consulta fornece fragments
como uma matriz de [Article]
.
{
bookmarkList {
items {
fragments {
_path
author
}
}
}
}
Esta consulta interroga:
bookmark
Article
e Adventure
O campo fragments
tem o tipo de dados fragment-reference
, com os modelos Article
e Adventure
selecionados. A consulta entrega fragments
como uma matriz de [AllFragmentModels]
, que é desreferenciada com o tipo de união.
{
bookmarkList {
items {
fragments {
... on ArticleModel {
_path
author
}
... on AdventureModel {
_path
adventureTitle
}
}
}
}
}
Há duas opções desta consulta:
attachments
.Essas consultas interrogam:
bookmark
A consulta a seguir retorna todas as referências de conteúdo usando _references
:
{
bookmarkList {
_references {
... on ImageRef {
_path
type
height
}
... on MultimediaRef {
_path
type
size
}
... on DocumentRef {
_path
type
author
}
... on ArchiveRef {
_path
type
format
}
}
items {
_path
}
}
}
A consulta a seguir retorna todos os attachments
- um campo específico (subgrupo) de tipo content-reference
:
O campo attachments
tem o tipo de dados content-reference
, com vários formulários selecionados.
{
bookmarkList {
items {
attachments {
... on PageRef {
_path
type
}
... on ImageRef {
_path
width
}
... on MultimediaRef {
_path
size
}
... on DocumentRef {
_path
author
}
... on ArchiveRef {
_path
format
}
}
}
}
}
Esta consulta interroga:
bookmark
em um caminho específico
As referências em linha do RTE são hidratadas em _references
.
Exemplo de consulta
{
bookmarkByPath(_path: "/content/dam/wknd/en/bookmarks/skitouring") {
item {
_path
description {
json
}
}
_references {
... on ArticleModel {
_path
}
... on AdventureModel {
_path
}
... on ImageRef {
_path
}
... on MultimediaRef {
_path
}
... on DocumentRef {
_path
}
... on ArchiveRef {
_path
}
}
}
}
Esta consulta interroga:
author
em um caminho específico
another
Exemplo de consulta
{
authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo", variation: "another") {
item {
_path
_variation
firstName
lastName
birthDay
}
}
}
Esta consulta interroga:
author
com uma variação específica: another
Isso demonstrará o fallback dos fragmentos de conteúdo que não têm uma Variação do nome especificado.
Exemplo de consulta
{
authorList(variation: "another") {
items {
_path
_variation
firstName
lastName
birthDay
}
}
}
Esta consulta interroga:
article
no local fr
Exemplo de consulta
{
articleList(_locale: "fr") {
items {
_path
authorFragment {
_path
firstName
lastName
birthDay
}
main {
html
markdown
plaintext
json
}
}
}
}
Esta consulta interroga:
Exemplo de consulta
{
articleList(offset: 5, limit: 5) {
items {
authorFragment {
_path
firstName
lastName
birthDay
}
_path
}
}
}
Esta consulta interroga:
Exemplo de consulta
{
adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
edges {
cursor
node {
title
}
}
pageInfo {
endCursor
hasNextPage
}
}
}
Os exemplos de consultas são baseados na seguinte estrutura, que usa:
Um ou mais, exemplos de Modelos de fragmento de conteúdo - formam a base para os esquemas GraphQL
Exemplos de Fragmentos de conteúdo com base nos modelos acima referidos
Para o exemplo de consultas, usaremos os seguintes Modelos de conteúdo e suas interrelações (referências ->):
Os campos básicos que definem a empresa são:
Nome do campo | Tipo de dados | Referência |
---|---|---|
Nome da empresa | Texto em linha única | |
CEO | Referência do fragmento (único) | Pessoa |
Empregados | Referência do fragmento (vários campos) | Pessoa |
Os campos que definem uma pessoa, que também pode ser um funcionário:
Nome do campo | Tipo de dados | Referência |
---|---|---|
Nome | Texto em linha única | |
Nome | Texto em linha única | |
Prêmios | Referência do fragmento (vários campos) | Prêmio |
Os campos que definem um prêmio são:
Nome do campo | Tipo de dados | Referência |
---|---|---|
Atalho/ID | Texto em linha única | |
Título | Texto em linha única |
Os campos para definir uma cidade são:
Nome do campo | Tipo de dados | Referência |
---|---|---|
Nome | Texto em linha única | |
País | Texto em linha única | |
População | Número | |
Categorias | Tags |
Os fragmentos a seguir são usados para o modelo apropriado.
Nome da empresa | CEO | Empregados |
---|---|---|
Apple | Steve Jobs | Duke Marsh Max Caulfield |
Little Pony Inc. | Adam Smith | Lara Croft Cutter Slade |
NextStep Inc. | Steve Jobs | Joe Smith Abe Lincoln |
Nome | Nome | Prêmios |
---|---|---|
Lincoln | Abe | |
Smith | Adam | |
Slade | Cutter | Gameblitz Gamestar |
Marsh | Duke | |
Smith | Joe | |
Croft | Lara | Gamestar |
Caulfield | Max | Gameblitz |
Tarefas | Steve |
Atalho/ID | Título |
---|---|
GB | Gameblitz |
GS | Gamestar |
OSC | Oscar |
Nome | País | População | Categorias |
---|---|---|---|
Basileia | Suíça | 172258 | city:emea |
Berlim | Alemanha | 3669491 | city:capital city:emea |
Bucareste | Romênia | 1821000 | city:capital city:emea |
São Francisco | EUA | 883306 | city:beach city:na |
San Jose | EUA | 102635 | city:na |
Stuttgart | Alemanha | 634830 | city:emea |
Zurique | Suíça | 415367 | city:capital city:emea |