그룹 위키 API

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

그룹 위키 API는 APIv4에서만 사용 가능합니다.
프로젝트 위키 API도 사용할 수 있습니다.

위키 페이지 목록

주어진 그룹의 모든 위키 페이지를 나열합니다.

GET /groups/:id/wikis
속성 타입 필수 설명
id integer/string 예 그룹의 ID 또는 URL-인코딩된 경로입니다.
with_content boolean 아니오 페이지의 콘텐츠를 포함합니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/wikis?with_content=1"

예제 응답:

[
  {
    "content" : "이 프로젝트를 배포하는 방법에 대한 설명입니다.",
    "format" : "markdown",
    "slug" : "deploy",
    "title" : "배포",
    "encoding": "UTF-8"
  },
  {
    "content" : "우리의 개발 프로세스는 여기서 설명됩니다.",
    "format" : "markdown",
    "slug" : "development",
    "title" : "개발",
    "encoding": "UTF-8"
  },{
    "content" : "*  [배포](deploy)\n*  [개발](development)",
    "format" : "markdown",
    "slug" : "home",
    "title" : "홈",
    "encoding": "UTF-8"
  }
]

위키 페이지 가져오기

주어진 그룹의 위키 페이지를 가져옵니다.

GET /groups/:id/wikis/:slug
속성 타입 필수 설명
id integer/string 예 그룹의 ID 또는 URL-인코딩된 경로입니다.
slug string 예 위키 페이지의 URL-인코딩된 슬러그(고유 문자열)입니다. 예: dir%2Fpage_name.
render_html boolean 아니오 위키 페이지의 렌더링된 HTML을 반환합니다.
version string 아니오 위키 페이지 버전 SHA. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/wikis/home"

예제 응답:

{
  "content" : "홈 페이지",
  "format" : "markdown",
  "slug" : "home",
  "title" : "홈",
  "encoding": "UTF-8"
}

새로운 위키 페이지 만들기

주어진 레포지토리에 대해 주어진 제목, 슬러그 및 콘텐츠로 새로운 위키 페이지를 작성합니다.

POST /projects/:id/wikis
속성 타입 필수 설명
id integer/string 예 그룹의 ID 또는 URL-인코딩된 경로입니다.
content string 예 위키 페이지의 콘텐츠입니다.
title string 예 위키 페이지의 제목입니다.
format string 아니오 위키 페이지의 형식입니다. 사용 가능한 형식은: markdown(기본값), rdoc, asciidoc, org입니다. 
curl --data "format=rdoc&title=안녕하세요&content=안녕하세요 세상" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/1/wikis"

예제 응답:

{
  "content" : "안녕하세요 세상",
  "format" : "markdown",
  "slug" : "안녕하세요",
  "title" : "안녕하세요",
  "encoding": "UTF-8"
}

기존 위키 페이지 편집

기존 위키 페이지를 업데이트합니다. 위키 페이지를 업데이트하려면 하나 이상의 매개변수가 필요합니다.

PUT /groups/:id/wikis/:slug
속성 유형 필수 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩된 경로입니다.
content string 예, title이 제공되지 않은 경우 위키 페이지의 내용입니다.
title string 예, content가 제공되지 않은 경우 위키 페이지의 제목입니다.
format string 아니오 위키 페이지의 형식입니다. 사용 가능한 형식은 markdown(기본값), rdoc, asciidoc, org입니다.
slug string 예 위키 페이지의 URL 인코딩된 슬러그(고유 문자열)입니다. 예: dir%2Fpage_name. 
curl --request PUT --data "format=rdoc&content=documentation&title=Docs" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/1/wikis/foo"

예시 응답:

{
  "content" : "documentation",
  "format" : "markdown",
  "slug" : "Docs",
  "title" : "Docs",
  "encoding": "UTF-8"
}

위키 페이지 삭제

주어진 슬러그로 위키 페이지를 삭제합니다.

DELETE /groups/:id/wikis/:slug
속성 유형 필수 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩된 경로입니다.
slug string 예 위키 페이지의 URL 인코딩된 슬러그(고유 문자열)입니다. 예: dir%2Fpage_name. 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/wikis/foo"

성공 시, 빈 본문이 포함된 204 No Content HTTP 응답이 예상됩니다.

위키 저장소에 첨부 파일 업로드

위키의 저장소 내 첨부 파일 폴더에 파일을 업로드합니다.

첨부 파일 폴더는 uploads 폴더입니다.

POST /groups/:id/wikis/attachments
속성 유형 필수 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩된 경로입니다.
file string 예 업로드할 첨부 파일입니다.
branch string 아니오 브랜치의 이름입니다. 기본값은 위키 저장소의 기본 브랜치입니다.

파일 시스템에서 파일을 업로드하려면 --form 인수를 사용합니다. 이는 cURL에게 Content-Type: multipart/form-data 헤더를 사용하여 데이터를 전송하게 합니다.

file= 매개변수는 파일 시스템의 파일을 가리켜야 하며 @ 접두사가 있어야 합니다. 예:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --form "file=@dk.png" "https://gitlab.example.com/api/v4/groups/1/wikis/attachments"

예시 응답:

{
  "file_name" : "dk.png",
  "file_path" : "uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png",
  "branch" : "main",
  "link" : {
    "url" : "uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png",
    "markdown" : "![dk](uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png)"
  }
}