GraphQL API 살펴보기

마지막 업데이트: 2023-07-31
  • 작성 대상:
  • Beginner
    Developer

AEM의 GraphQL API는 콘텐츠 조각의 데이터를 다운스트림 애플리케이션에 노출하는 강력한 쿼리 언어를 제공합니다. 콘텐츠 조각 모델은 콘텐츠 조각에서 사용하는 데이터 스키마를 정의합니다. 콘텐츠 조각 모델을 만들거나 업데이트할 때마다 스키마는 번역되고 GraphQL API를 구성하는 "그래프"에 추가됩니다.

이 장에서는 IDE를 사용하여 콘텐츠를 수집하기 위한 몇 가지 일반적인 GraphQL 쿼리에 대해 알아보겠습니다. GraphiQL. GraphiQL IDE를 사용하면 반환된 쿼리 및 데이터를 빠르게 테스트하고 구체화할 수 있습니다. 또한 설명서에 쉽게 액세스할 수 있으므로 사용 가능한 방법을 쉽게 배우고 이해할 수 있습니다.

사전 요구 사항

이 자습서는 여러 부분으로 구성되어 있으며 다음에 설명된 단계를 가정합니다. 컨텐츠 조각 작성 완료되었습니다.

목표

  • GraphiQL 도구를 사용하여 GraphQL 구문을 사용하여 쿼리를 구성하는 방법을 알아봅니다.
  • 콘텐츠 조각 목록 및 단일 콘텐츠 조각을 쿼리하는 방법에 대해 알아봅니다.
  • 특정 데이터 속성을 필터링하고 요청하는 방법을 알아봅니다.
  • 여러 콘텐츠 조각 모델의 쿼리에 결합하는 방법을 알아봅니다
  • GraphQL 쿼리를 지속하는 방법을 알아봅니다.

GraphQL 엔드포인트 활성화

컨텐츠 조각에 대해 GraphQL API 쿼리를 활성화하려면 GraphQL 끝점을 구성해야 합니다.

  1. AEM 시작 화면에서 다음으로 이동합니다. 도구 > 일반 > GraphQL.

    GraphQL 엔드포인트로 이동

  2. 누르기 만들기 오른쪽 상단 모서리의 결과 대화 상자에 다음 값을 입력합니다.

    • 이름*: 내 프로젝트 엔드포인트.
    • 에서 제공한 GraphQL 스키마 사용… *: 내 프로젝트

    GraphQL 엔드포인트 만들기

    누르기 만들기 끝점을 저장합니다.

    프로젝트 구성을 기반으로 생성된 GraphQL 엔드포인트는 해당 프로젝트에 속한 모델에 대한 쿼리만 활성화합니다. 이 경우 다음에 대한 유일한 쿼리 개인 모델을 사용할 수 있습니다.

    노트

    전역 끝점을 만들어 여러 구성에서 모델에 대한 쿼리를 활성화할 수도 있습니다. 이 경우 보안 취약성이 가중되고 AEM 관리가 전반적으로 복잡해질 수 있으므로 주의하여 사용해야 합니다.

  3. 이제 환경에 GraphQL 엔드포인트가 1개 활성화되어 표시됩니다.

    Graphql 끝점 활성화됨

GraphiQL IDE 사용

다음 GraphiQL 개발자는 이 도구를 사용하여 현재 AEM 환경의 콘텐츠에 대한 쿼리를 만들고 테스트할 수 있습니다. GraphiQL 도구를 통해 다음과 같은 작업을 수행할 수 있습니다 지속 또는 저장 프로덕션 설정에서 클라이언트 애플리케이션에서 사용할 쿼리입니다.

이제 내장된 GraphiQL IDE를 사용하여 AEM GraphQL API의 강력한 기능을 살펴보십시오.

  1. AEM 시작 화면에서 다음으로 이동합니다. 도구 > 일반 > GraphQL 쿼리 편집기.

    GraphiQL IDE로 이동

    노트

    에서 이전 버전의 AEM에 GraphiQL IDE가 빌드되지 않을 수 있습니다. 다음 단계에 따라 수동으로 설치할 수 있습니다 지침.

  2. 오른쪽 상단 모서리에서 끝점이 로 설정되어 있는지 확인합니다. 내 프로젝트 엔드포인트.

    GraphQL 끝점 설정

이렇게 하면 모든 쿼리가 내 프로젝트 프로젝트.

콘텐츠 조각 목록 쿼리

일반적인 요구 사항은 여러 콘텐츠 조각을 쿼리하는 것입니다.

  1. 주 패널에 다음 쿼리를 붙여 넣습니다(주석 목록 대체).

    query allTeams {
      teamList {
        items {
          _path
          title
        }
      }
    }
    
  2. 누르기 재생 단추를 클릭하여 쿼리를 실행합니다. 이전 장의 콘텐츠 조각 결과가 표시되어야 합니다.

    개인 목록 결과

  3. 커서를 아래에 놓습니다. title 텍스트 및 입력 CTRL+스페이스바 코드 힌트를 트리거합니다. 추가 shortnamedescription 을 클릭하여 쿼리를 만듭니다.

    코드 히팅으로 쿼리 업데이트

  4. 쿼리를 다시 실행하려면 재생 을 누르고 있으면 결과에 의 추가 속성이 포함되어 있음을 알 수 있습니다 shortnamedescription.

    바로 가기 이름 및 설명 결과

    다음 shortname 는 단순 속성이며 description 는 여러 줄 텍스트 필드이며 GraphQL API를 통해 다음과 같은 결과에 대한 다양한 형식을 선택할 수 있습니다. html, markdown, json, 또는 plaintext.

중첩된 조각 쿼리

다음으로, 쿼리 실험은 중첩된 조각을 검색하는 것입니다. 모델은 개인 모델.

  1. 쿼리를 업데이트하여 teamMembers 속성. 이 은(는) 조각 참조 개인 모델에 대한 필드입니다. 개인 모델의 속성을 반환할 수 있습니다.

    query allTeams {
        teamList {
            items {
                _path
                title
                shortName
                description {
                    plaintext
                }
                teamMembers {
                    fullName
                    occupation
                }
            }
        }
    }
    

    JSON 응답:

    {
        "data": {
            "teamList": {
            "items": [
                {
                "_path": "/content/dam/my-project/en/team-alpha",
                "title": "Team Alpha",
                "shortName": "team-alpha",
                "description": {
                    "plaintext": "This is a description of Team Alpha!"
                },
                "teamMembers": [
                    {
                    "fullName": "John Doe",
                    "occupation": [
                        "Artist",
                        "Influencer"
                    ]
                    },
                    {
                    "fullName": "Alison Smith",
                    "occupation": [
                        "Photographer"
                    ]
                    }
                  ]
            }
            ]
            }
        }
    }
    

    중첩된 조각에 대해 쿼리하는 기능은 AEM GraphQL API의 강력한 기능입니다. 이 간단한 예제에서 중첩은 두 수준 깊이입니다. 그러나 조각을 더 멀리 중첩할 수 있습니다. 예를 들어 주소 와(과) 연계된 모델 개인 단일 쿼리로 세 모델의 데이터를 모두 반환할 수 있습니다.

콘텐츠 조각 목록 필터링

다음으로, 속성 값을 기반으로 결과를 콘텐츠 조각의 하위 집합으로 필터링하는 방법을 살펴보겠습니다.

  1. GraphiQL UI에 다음 쿼리를 입력합니다.

    query personByName($name:String!){
      personList(
        filter:{
          fullName:{
            _expressions:[{
              value:$name
              _operator:EQUALS
            }]
          }
        }
      ){
        items{
          _path
          fullName
          occupation
        }
      }
    }
    

    위의 쿼리는 시스템의 모든 개인 조각에 대해 검색을 수행합니다. 쿼리 시작 부분에 추가된 필터는 name 필드 및 변수 문자열 $name.

  2. 다음에서 쿼리 변수 패널 다음을 입력합니다.

    {"name": "John Doe"}
    
  3. 쿼리를 실행합니다. 개인 컨텐츠 조각이 값과 함께 반환됩니다. John Doe.

    쿼리 변수를 사용하여 필터링

    복잡한 쿼리를 필터링하고 만드는 다른 많은 옵션이 있습니다. 다음을 참조하십시오. AEM에서 GraphQL을 사용하는 방법 알아보기 - 샘플 콘텐츠 및 쿼리.

  4. 프로필 사진을 가져오기 위해 위의 쿼리 향상

    query personByName($name:String!){
      personList(
        filter:{
          fullName:{
            _expressions:[{
              value:$name
              _operator:EQUALS
            }]
          }
        }
      ){
        items{
          _path
          fullName
          occupation
          profilePicture{
            ... on ImageRef{
              _path
              _authorUrl
              _publishUrl
              height
              width
    
            }
          }
        }
      }
    }
    

    다음 profilePicture 는 콘텐츠 참조이며 기본 제공된 이미지여야 합니다. ImageRef 개체가 사용됩니다. 이를 통해 다음과 같이 참조 중인 이미지에 대한 추가 데이터를 요청할 수 있습니다. widthheight.

단일 콘텐츠 조각 쿼리

단일 콘텐츠 조각을 직접 쿼리할 수도 있습니다. AEM의 콘텐츠는 계층적 방식으로 저장되며 조각의 고유 식별자는 조각의 경로를 기반으로 합니다.

  1. GraphiQL 편집기에 다음 쿼리를 입력합니다.

    query personByPath($path: String!) {
        personByPath(_path: $path) {
            item {
            fullName
            occupation
            }
        }
    }
    
  2. 다음에 대해 다음을 입력합니다. 쿼리 변수:

    {"path": "/content/dam/my-project/en/alison-smith"}
    
  3. 쿼리를 실행하고 단일 결과가 반환되는지 확인합니다.

쿼리 지속

개발자가 쿼리에서 반환된 쿼리 및 결과 데이터에 만족하면 다음 단계로 쿼리를 AEM에 저장하거나 지속합니다. 다음 지속 쿼리 는 GraphQL API를 클라이언트 애플리케이션에 노출하는 데 선호되는 메커니즘입니다. 쿼리가 지속되면 GET 요청을 사용하여 요청하고 Dispatcher 및 CDN 계층에서 캐시할 수 있습니다. 지속 쿼리의 성능이 훨씬 뛰어납니다. 지속 쿼리는 성능 이점 외에도 추가 데이터가 클라이언트 애플리케이션에 실수로 노출되지 않도록 합니다. 에 대한 추가 세부 정보 지속 쿼리는 여기에서 찾을 수 있습니다..

그런 다음 두 개의 간단한 쿼리를 지속하면 다음 장에서 사용됩니다.

  1. GraphiQL IDE에 다음 쿼리를 입력하십시오.

    query allTeams {
        teamList {
            items {
                _path
                title
                shortName
                description {
                    plaintext
                }
                teamMembers {
                    fullName
                    occupation
                }
            }
        }
    }
    

    쿼리가 작동하는지 확인합니다.

  2. 다음 탭 다른 이름으로 저장 및 입력 all-teams (으)로 쿼리 이름.

    쿼리는 아래에 표시되어야 합니다. 지속 쿼리 왼쪽 레일에서.

    모든 팀 지속 쿼리

  3. 그런 다음 생략 부호를 탭합니다 지속 쿼리 옆에 있는 다음 을 누릅니다. URL 복사 클립보드에 경로를 복사합니다.

    지속 쿼리 URL 복사

  4. 새 탭을 열고 복사한 경로를 브라우저에 붙여넣습니다.

    https://$YOUR-AEMasCS-INSTANCEID$.adobeaemcloud.com/graphql/execute.json/my-project/all-teams
    

    위의 경로와 유사해야 합니다. 쿼리의 JSON 결과가 반환되었는지 확인해야 합니다.

    위의 URL 분류:

    이름 설명
    /graphql/execute.json 지속 쿼리 끝점
    /my-project 프로젝트 구성 /conf/my-project
    /all-teams 지속 쿼리의 이름
  5. GraphiQL IDE로 돌아가 더하기 버튼을 사용합니다. + 새 쿼리를 지속하려면

    query personByName($name: String!) {
      personList(
        filter: {
          fullName:{
            _expressions: [{
              value: $name
              _operator:EQUALS
            }]
          }
        }){
        items {
          _path
          fullName
          occupation
          biographyText {
            json
          }
          profilePicture {
            ... on ImageRef {
              _path
              _authorUrl
              _publishUrl
              width
              height
            }
          }
        }
      }
    }
    
  6. 쿼리를 다른 이름으로 저장: person-by-name.

  7. 두 개의 지속 쿼리가 저장되어야 합니다.

    최종 지속 쿼리

GraphQL 엔드포인트 및 지속 쿼리 게시

검토 및 확인 후 GraphQL EndpointPersisted Queries

  1. AEM 시작 화면에서 다음으로 이동합니다. 도구 > 일반 > GraphQL.

  2. 옆에 있는 확인란을 탭합니다. 내 프로젝트 엔드포인트 및 탭 게시

    GraphQL 엔드포인트 게시

  3. AEM 시작 화면에서 다음으로 이동합니다. 도구 > 일반 > GraphQL 쿼리 편집기

  4. 모든 팀 지속 쿼리 패널에서 쿼리 및 탭 게시

    지속 쿼리 게시

  5. 다음 기간 동안 위 단계를 반복합니다. person-by-name 쿼리

솔루션 파일

마지막 세 개의 챕터에서 만든 콘텐츠, 모델 및 지속 쿼리를 다운로드합니다. basic-tutorial-solution.content.zip

추가 리소스

에서 GraphQL 쿼리에 대해 자세히 알아봅니다. AEM에서 GraphQL을 사용하는 방법 알아보기 - 샘플 콘텐츠 및 쿼리.

축하합니다!

축하합니다. 여러 GraphQL 쿼리를 만들고 실행했습니다!

다음 단계

다음 장에서는 React 앱 빌드에서는 외부 애플리케이션이 AEM GraphQL 종단점을 쿼리하고 이 두 개의 지속 쿼리를 사용하는 방법을 탐색합니다. GraphQL 쿼리 실행 중 발생하는 몇 가지 기본적인 오류 처리도 소개합니다.

GraphiQL 도구 설치(선택 사항)

의 일부 AEM 버전(6.X.X)에서는 GraphiQL IDE 도구를 수동으로 설치해야 합니다. 여기의 지침.

이 페이지의