From 6ba69dfbd308cdfba53f952648c3ca04894816cc Mon Sep 17 00:00:00 2001 From: Junseong Park <39112954+jsparkdev@users.noreply.github.com> Date: Fri, 18 Apr 2025 22:48:13 +0900 Subject: [PATCH] i18n(ko-KR): create `restapi.mdx` --- src/content/docs/ko/how-it-works/restapi.mdx | 42 ++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 src/content/docs/ko/how-it-works/restapi.mdx diff --git a/src/content/docs/ko/how-it-works/restapi.mdx b/src/content/docs/ko/how-it-works/restapi.mdx new file mode 100644 index 00000000..8e5c21bc --- /dev/null +++ b/src/content/docs/ko/how-it-works/restapi.mdx @@ -0,0 +1,42 @@ +--- +i18nReady: true +title: "REST API" +description: "StudioCMS REST API와 사용법에 대해 알아보세요." +sidebar: + order: 4 +--- + +# 소개 + +StudioCMS REST API는 프로그래밍 방식으로 StudioCMS 콘텐츠와 상호 작용할 수 있게 해주는 강력한 도구입니다. Astro DB를 사용하여 콘텐츠를 관리하고 제공하는 간단하고 유연한 방법을 제공합니다. + +StudioCMS REST API는 Astro 엔드포인트를 기반으로 하며, StudioCMS 콘텐츠와 상호 작용하기 위한 RESTful 인터페이스를 제공합니다. 아래는 StudioCMS REST API와 그 구성 요소에 대한 세부 정보입니다. + +## API 토큰 + +StudioCMS REST API의 보호된 엔드포인트에 접근하려면 요청의 `Authorization` 헤더에 API 토큰을 제공해야 합니다. API 토큰은 StudioCMS 대시보드에 로그인하여 사용자 프로필의 "API Tokens" 섹션에서 생성할 수 있습니다. + +## 엔드포인트 + +StudioCMS REST API는 StudioCMS 콘텐츠와 상호 작용할 수 있는 여러 엔드포인트를 제공합니다. 이러한 엔드포인트는 주로 StudioCMS 내부에서 사용되지만, 개발자도 StudioCMS 데이터와 상호 작용하기 위해 접근할 수 있습니다. StudioCMS REST API에서 제공하는 엔드포인트는 다음과 같습니다. + +### 공개 엔드포인트 + +이러한 엔드포인트는 공개적으로 접근 가능하며 인증이 필요하지 않습니다. StudioCMS 콘텐츠 트리에 대한 읽기 전용 접근 권한을 제공합니다. 따라서 이러한 엔드포인트는 `GET` 요청만 지원합니다. + +- **`/studiocms_api/rest/v1/public/folders/`**: StudioCMS 콘텐츠 트리의 모든 공개 폴더 목록을 제공합니다. +- **`/studiocms_api/rest/v1/public/folders/[id]`**: StudioCMS 콘텐츠 트리의 특정 공개 폴더에 대한 세부 정보를 제공합니다. +- **`/studiocms_api/rest/v1/public/pages/`**: StudioCMS 콘텐츠 트리의 모든 공개 페이지 목록을 제공합니다. +- **`/studiocms_api/rest/v1/public/pages/[id]`**: StudioCMS 콘텐츠 트리의 특정 공개 페이지에 대한 세부 정보를 제공합니다. + +### 보호된 엔드포인트 + +- **`/studiocms_api/rest/v1/folders/`**: StudioCMS 콘텐츠 트리의 모든 폴더 목록을 제공합니다. +- **`/studiocms_api/rest/v1/folders/[id]`**: StudioCMS 콘텐츠 트리의 특정 폴더에 대한 세부 정보를 제공합니다. +- **`/studiocms_api/rest/v1/pages/`**: StudioCMS 콘텐츠 트리의 모든 페이지 목록을 제공합니다. +- **`/studiocms_api/rest/v1/pages/[id]`**: StudioCMS 콘텐츠 트리의 특정 페이지에 대한 세부 정보를 제공합니다. +- **`/studiocms_api/rest/v1/pages/[id]/history/`**: StudioCMS 콘텐츠 트리의 특정 페이지의 모든 변경 이력 항목 목록을 제공합니다. +- **`/studiocms_api/rest/v1/pages/[id]/history/[id]`**: StudioCMS 콘텐츠 트리의 특정 페이지 변경 이력 항목에 대한 세부 정보를 제공합니다. +- **`/studiocms_api/rest/v1/settings/`**: 현재 프로젝트의 StudioCMS 설정을 제공합니다. +- **`/studiocms_api/rest/v1/users/`**: StudioCMS 프로젝트의 모든 사용자 목록을 제공합니다. +- **`/studiocms_api/rest/v1/users/[id]`**: StudioCMS 프로젝트의 특정 사용자에 대한 세부 정보를 제공합니다.