프로젝트 위키 API

프로젝트 위키 API에 대해 설명합니다.

이 API를 사용하여 프로젝트 위키 를 관리합니다. 그룹 위키 를 위한 API도 사용 가능합니다. 위키 페이지의 댓글은 notes 라고 합니다. 이와 상호 작용하려면 노트 API 를 사용합니다. 모든 위키 페이지 목록 조회 # 지정된 프로젝트의 모든 위키 페이지를 나열합니다. GET /projects/:id/wikis 속성 유형 필수 여부 설명 id integer or string 예 프로젝트의 ID 또는 URL 인코딩된 경로 . with_content boolean 아니요 페이지 콘텐츠를 포함합니다. curl --header "PRIVATE-TOKEN: <your_access_token>" \ --url "https://gitlab.example.com/api/v4/projects/1/wikis?with_content=1" 응답 예시: [ { "content" : "Here is an instruction how to deploy this project." , "format" : "markdown" , "slug" : "deploy" , "title" : "deploy" , "encoding" : "UTF-8" } , { "content" : "Our development process is described here." , "format" : "markdown" , "slug" : "development" , "title" : "development" , "encoding" : "UTF-8" } , { "content" : "* [Deploy](deploy)\n* [Development](development)" , "format" : "markdown" , "slug" : "home" , "title" : "home" , "encoding" : "UTF-8" } ] 위키 페이지 조회 # 프로젝트의 지정된 위키 페이지를 조회합니다. GET /projects/:id/wikis/:slug 속성 유형 필수 여부 설명 id integer or string 예 프로젝트의 ID 또는 URL 인코딩된 경로 . slug string 예 URL 인코딩된 슬러그(고유 문자열)(예: dir%2Fpage_name ). render_html boolean 아니요 위키 페이지의 렌더링된 HTML을 반환합니다. version string 아니요 위키 페이지 버전 SHA. curl --header "PRIVATE-TOKEN: <your_access_token>" \ --url "https://gitlab.example.com/api/v4/projects/1/wikis/home" 응답 예시: { "content" : "home page" , "format" : "markdown" , "slug" : "home" , "title" : "home" , "encoding" : "UTF-8" } 위키 페이지 만들기 # 지정된 프로젝트에 제목, 슬러그, 콘텐츠를 사용하여 위키 페이지를 만듭니다. POST /projects/:id/wikis 속성 유형 필수