Drupal & Astro
Drupal은 오픈소스 콘텐츠 관리 도구입니다.
전제 조건
섹션 제목: “전제 조건”시작하려면 다음이 필요합니다:
-
Astro 프로젝트 - 아직 Astro 프로젝트가 없는 경우, 설치 가이드를 참조하면 금방 시작할 수 있습니다.
-
Drupal 사이트 - Drupal 사이트를 설정하지 않은 경우 공식 가이드라인 Drupal 설치하기를 따르세요.
Drupal과 Astro 통합
섹션 제목: “Drupal과 Astro 통합”JSON:API Drupal 모듈 설치하기
섹션 제목: “JSON:API Drupal 모듈 설치하기”Drupal에서 콘텐츠를 가져오려면 Drupal JSON:API 모듈을 활성화해야 합니다.
- Manage administrative 메뉴를 통해 Extend 페이지
admin/modules로 이동합니다. - JSON:API 모듈을 찾아 옆의 확인란을 선택합니다.
- Install을 클릭하여 새 모듈을 설치합니다.
이제 JSON:API를 통해 Drupal 애플리케이션에 GET 요청을 할 수 있습니다.
.env에 Drupal URL 추가하기
섹션 제목: “.env에 Drupal URL 추가하기”Astro에 Drupal URL을 추가하려면 프로젝트의 루트에 .env 파일을 만들고 (아직 없는 경우) 다음 변수를 추가하세요:
DRUPAL_BASE_URL="https://drupal.ddev.site/"개발 서버를 재시작하여 Astro 프로젝트에서 이 환경 변수를 사용하세요.
자격 증명 설정
섹션 제목: “자격 증명 설정”기본적으로 외부 데이터 가져오기 요청에 대해 인증 없이도 Drupal JSON:API 엔드포인트에 액세스할 수 있습니다. 이를 통해 자격 증명 없이도 Astro 프로젝트에서 데이터를 가져올 수 있지만 사용자가 데이터나 사이트 설정을 수정할 수는 없습니다.
그러나 액세스를 제한하고 인증이 필요한 경우 Drupal은 다음과 같은 여러 인증 방법을 제공합니다:
.env 파일에 자격 증명을 추가할 수 있습니다.
DRUPAL_BASIC_USERNAME="editor"DRUPAL_BASIC_PASSWORD="editor"DRUPAL_JWT_TOKEN="abc123"....env 파일에 대해 자세히 알아보세요.
이제 루트 디렉터리에 이 새 파일들이 포함되어야 합니다:
- .env
- astro.config.mjs
- package.json
종속성 설치
섹션 제목: “종속성 설치”JSON:API 요청과 응답은 종종 복잡하고 깊게 중첩될 수 있습니다. 작업을 간소화하기 위해 요청과 응답 처리를 모두 간소화하는 두 가지 npm 패키지를 사용할 수 있습니다:
JSONA: 서버와 브라우저에서 사용하기 위해 JSON API v1.0 사양을 직렬화 및 역직렬화 할 수 있습니다.Drupal JSON-API Params: 이 모듈은 필요한 쿼리를 생성하는 헬퍼 클래스를 제공합니다. 이 과정에서 가능한 경우 짧은 형식을 사용하여 쿼리를 최적화하려고 시도합니다.
npm install jsona drupal-jsonapi-paramspnpm add jsona drupal-jsonapi-paramsyarn add jsona drupal-jsonapi-paramsDrupal에서 데이터 가져오기
섹션 제목: “Drupal에서 데이터 가져오기”콘텐츠는 JSON:API URL에서 가져옵니다.
Drupal JSON:API URL 구조
섹션 제목: “Drupal JSON:API URL 구조”기본 URL 구조: /jsonapi/{entity_type_id}/{bundle_id}
URL 앞에는 항상 jsonapi가 붙습니다.
entity_type_id는 node, block, user 등의 엔티티 타입을 나타냅니다.bundle_id는 엔티티 번들을 나타냅니다. Node 엔티티 타입의 경우 번들은 article이 될 수 있습니다.- 이 경우 모든 articles 목록을 가져오기 위해 URL은
[DRUPAL_BASE_URL]/jsonapi/node/article이 됩니다.
개별 엔티티를 검색하기 위한 URL 구조는 /jsonapi/{entity_type_id}/{bundle_id}/{uuid}이며, 여기서 uuid는 엔티티의 UUID입니다. 예를 들어 특정 article을 가져오는 URL은 /jsonapi/node/article/2ee9f0ef-1b25-4bbe-a00f-8649c68b1f7e 형태가 됩니다.
특정 필드만 검색
섹션 제목: “특정 필드만 검색”쿼리 문자열 필드를 요청에 추가하여 특정 필드만 검색합니다.
GET: /jsonapi/{entity_type_id}/{bundle_id}?field[entity_type]=field_list
예시:
/jsonapi/node/article?fields[node--article]=title,created/jsonapi/node/article/2ee9f0ef-1b25-4bbe-a00f-8649c68b1f7e?fields[node--article]=title,created,body
필터링
섹션 제목: “필터링”쿼리 문자열 필터를 추가하여 요청에 필터를 추가합니다.
가장 간단하고 일반적인 필터는 키-값 필터입니다:
GET: /jsonapi/{entity_type_id}/{bundle_id}?filter[field_name]=value&filter[field_other]=value
예시:
/jsonapi/node/article?filter[title]=Testing JSON:API&filter[status]=1/jsonapi/node/article/2ee9f0ef-1b25-4bbe-a00f-8649c68b1f7e?fields[node--article]=title&filter[title]=Testing JSON:API
더 많은 쿼리 옵션은 JSON:API 문서에서 확인할 수 있습니다.
Drupal 쿼리 작성하기
섹션 제목: “Drupal 쿼리 작성하기”Astro 컴포넌트는 drupal-jsonapi-params 패키지로 쿼리를 작성하여 Drupal 사이트에서 데이터를 가져올 수 있습니다.
다음 예시는 “article” 콘텐츠 타입을 쿼리하는 컴포넌트를 보여줍니다. 이 콘텐츠 타입은 제목용 일반 텍스트 필드와 본문용 서식 있는 텍스트 필드를 포함하고 있습니다.
---import {Jsona} from "jsona";import {DrupalJsonApiParams} from "drupal-jsonapi-params";import type {TJsonApiBody} from "jsona/lib/JsonaTypes";
// Drupal 기본 URL 가져오기export const baseUrl: string = import.meta.env.DRUPAL_BASE_URL;
// JSON:API 쿼리를 생성합니다. 게시된 articles에서 모든 제목과 본문을 가져옵니다.const params: DrupalJsonApiParams = new DrupalJsonApiParams();params.addFields("node--article", [ "title", "body", ]) .addFilter("status", "1");// 쿼리 문자열 생성const path: string = params.getQueryString();const url: string = baseUrl + '/jsonapi/node/article?' + path;
// articles 가져오기const request: Response = await fetch(url);const json: string | TJsonApiBody = await request.json();// Jsona 초기화const dataFormatter: Jsona = new Jsona();// 응답 역직렬화const articles = dataFormatter.deserialize(json);---<body> {articles?.length ? articles.map((article: any) => ( <section> <h2>{article.title}</h2> <article set:html={article.body.value}></article> </section> )): <div><h1>No Content found</h1></div> }</body>