프로젝트 코드 조각

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

코드 조각 가시성 수준

GitLab의 코드 조각은 개인적으로, 내부적으로 또는 공개적으로 설정할 수 있습니다. visibility 필드를 사용하여 설정할 수 있습니다.

코드 조각 가시성 수준에 대한 상수는 다음과 같습니다.

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

참고: 2019년 7월부터 Internal 가시성 설정은 GitLab.com의 새로운 프로젝트, 그룹 및 코드 조각에서 비활성화되었습니다. 기존의 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",
  "imported": false,
  "imported_from": "none",
  "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 문자열 아니요 코드 조각의 가시성.

예시 요청: shell 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: 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 문자열 아니요 코드 조각의 가시성.

예시 요청: shell 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: 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 문자열 예 브랜치, 태그 또는 커밋의 이름, 예: master.
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
}