프로젝트 스니펫

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

스니펫 가시성 수준

GitLab의 스니펫은 개인, 내부 또는 공개로 설정할 수 있습니다. 스니펫의 visibility 필드로 설정할 수 있습니다.

스니펫 가시성 수준에 대한 상수는 다음과 같습니다:

  • Private: 스니펫은 프로젝트 구성원에게만 표시됩니다.
  • Internal: 스니펫은 외부 사용자를 제외한 모든 인증된 사용자에게 표시됩니다.
  • Public: 인증 없이 스니펫에 액세스할 수 있습니다.

참고: 2019년 7월부터 GitLab.com의 새 프로젝트, 그룹, 스니펫에서는 Internal 가시성 설정이 비활성화되었습니다. 기존 프로젝트, 그룹 및 스니펫에서는 Internal 가시성 설정이 유지됩니다. 해당 변경 사항에 대해 더 알아보려면 관련 이슈를 확인하세요.

스니펫 목록

프로젝트 스니펫 목록을 가져옵니다. 

GET /projects/:id/snippets

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로.

단일 스니펫

단일 프로젝트 스니펫을 가져옵니다. 

GET /projects/:id/snippets/:snippet_id

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로.
snippet_id 정수 예 프로젝트 스니펫의 ID. 
{
  "id": 1,
  "title": "test",
  "file_name": "add.rb",
  "description": "Ruby test snippet",
  "author": {
    "id": 1,
    "username": "john_smith",
    "email": "john@example.com",
    "name": "John Smith",
    "state": "active",
    "created_at": "2012-05-23T08:00:58Z"
  },
  "updated_at": "2012-06-28T10:52:04Z",
  "created_at": "2012-06-28T10:52:04Z",
  "project_id": 1,
  "web_url": "http://example.com/example/example/snippets/1",
  "raw_url": "http://example.com/example/example/snippets/1/raw"
}

새 스니펫 생성

새로운 프로젝트 스니펫을 생성합니다. 사용자는 새 스니펫을 만들 권한이 있어야 합니다. 

POST /projects/:id/snippets

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로.
files:content 문자열 예 스니펫 파일의 내용.
files:file_path 문자열 예 스니펫 파일의 경로.
title 문자열 예 스니펫 제목.
content 문자열 아니요 사용되지 않음: 대신 files를 사용하세요. 스니펫 내용.
description 문자열 아니요 스니펫 설명.
file_name 문자열 아니요 사용되지 않음: 대신 files를 사용하세요. 스니펫 파일의 이름.
files 해시 배열 아니요 스니펫 파일의 배열.
visibility 문자열 아니요 스니펫의 가시성.

예제 요청: 

curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
     --header "PRIVATE-TOKEN: <your access token>" \
     --header "Content-Type: application/json" \
     -d @snippet.json

상기 예제 요청에 사용된 snippet.json: 

{
  "title" : "Example Snippet Title",
  "description" : "More verbose snippet description",
  "visibility" : "private",
  "files": [
    {
      "file_path": "example.txt",
      "content" : "source code \n with multiple lines\n"
    }
  ]
}

스니펫 업데이트

기존 프로젝트 스니펫을 업데이트합니다. 사용자는 기존 스니펫을 변경할 권한이 있어야 합니다.

여러 파일이 있는 스니펫에 대한 업데이트는 files 속성을 사용해야 합니다. 

PUT /projects/:id/snippets/:snippet_id

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로.
files:action 문자열 예 파일에 수행할 작업 유형. create, update, delete, move 중 하나.
snippet_id 정수 예 프로젝트 스니펫의 ID.
content 문자열 아니요 사용되지 않음: 대신 files를 사용하세요. 스니펫 내용.
description 문자열 아니요 스니펫 설명.
files 해시 배열 아니요 스니펫 파일의 배열.
files:content 문자열 아니요 스니펫 파일의 내용.
files:file_path 문자열 아니요 스니펫 파일의 경로.
file_name 문자열 아니요 사용되지 않음: 대신 files를 사용하세요. 스니펫 파일의 이름.
files:previous_path 문자열 아니요 스니펫 파일의 이전 경로.
title 문자열 아니요 스니펫 제목.
visibility 문자열 아니요 스니펫의 가시성.

예제 요청: 

curl --request PUT "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
     --header "PRIVATE-TOKEN: <your access token>" \
     --header "Content-Type: application/json" \
     -d @snippet.json

상기 예제 요청에 사용된 snippet.json: 

{
  "title" : "Updated Snippet Title",
  "description" : "More verbose snippet description",
  "visibility" : "private",
  "files": [
    {
      "action": "update",
      "file_path": "example.txt",
      "content" : "updated source code \n with multiple lines\n"
    }
  ]
}

스니펫 삭제

기존 프로젝트 스니펫을 삭제합니다. 작업이 성공적으로 수행된 경우 204 No Content 상태 코드를 반환하며, 리소스를 찾을 수 없는 경우 404를 반환합니다. 

DELETE /projects/:id/snippets/:snippet_id

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
snippet_id 정수 예 프로젝트 스니펫의 ID입니다.

예시 요청: 

curl --request DELETE "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
     --header "PRIVATE-TOKEN: <your_access_token>"

스니펫 콘텐츠

원시 프로젝트 스니펫을 평문으로 반환합니다. 

GET /projects/:id/snippets/:snippet_id/raw

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
snippet_id 정수 예 프로젝트 스니펫의 ID입니다.

예시 요청: 

curl "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw" \
     --header "PRIVATE-TOKEN: <your_access_token>"

스니펫 리포지토리 파일 콘텐츠

원시 파일 콘텐츠를 평문으로 반환합니다. 

GET /projects/:id/snippets/:snippet_id/files/:ref/:file_path/raw

매개변수:

속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
file_path 문자열 예 파일에 대한 URL 인코딩된 경로입니다. 예를 들어 snippet%2Erb입니다.
ref 문자열 예 브랜치, 태그 또는 커밋의 이름입니다. 예를 들어 main입니다.
snippet_id 정수 예 프로젝트 스니펫의 ID입니다.

예시 요청: 

curl "https://gitlab.com/api/v4/projects/1/snippets/2/files/master/snippet%2Erb/raw" \
     --header "PRIVATE-TOKEN: <your_access_token>"

사용자 에이전트 세부정보 가져오기

관리자 권한이 있는 사용자만 사용할 수 있습니다. 

GET /projects/:id/snippets/:snippet_id/user_agent_detail
속성 유형 필수 설명
id 정수 또는 문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로입니다.
snippet_id 정수 예 스니펫의 ID입니다.

예시 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail"

예시 응답: 

{
  "user_agent": "AppleWebKit/537.36",
  "ip_address": "127.0.0.1",
  "akismet_submitted": false
}