Snippets API

原文：https://docs.gitlab.com/ee/api/snippets.html

• Snippet visibility level
• List all snippets for a user
• Get a single snippet
• Single snippet contents
• Snippet repository file content
• Create new snippet
• Update snippet
• Delete snippet
• List all public snippets
• Get user agent details

Snippets API

在 GitLab 8.15 中引入 .

片段 API 在片段上运行.

Snippet visibility level

GitLab 中的代码段可以是私有的，内部的或公共的. 您可以使用代码段中的visibility字段进行设置.

代码段可见性级别的有效值为：

List all snippets for a user

获取当前用户的片段列表.

GET /snippets 

请求示例：

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

响应示例：

[  {  "id":  42,  "title":  "Voluptatem iure ut qui aut et consequatur quaerat.",  "file_name":  "mclaughlin.rb",  "description":  null,  "visibility":  "internal",  "author":  {  "id":  22,  "name":  "User 0",  "username":  "user0",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",  "web_url":  "http://example.com/user0"  },  "updated_at":  "2018-09-18T01:12:26.383Z",  "created_at":  "2018-09-18T01:12:26.383Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/42",  "raw_url":  "http://example.com/snippets/42/raw"  },  {  "id":  41,  "title":  "Ut praesentium non et atque.",  "file_name":  "ondrickaemard.rb",  "description":  null,  "visibility":  "internal",  "author":  {  "id":  22,  "name":  "User 0",  "username":  "user0",  "state":  "active",  "avatar_url":  "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",  "web_url":  "http://example.com/user0"  },  "updated_at":  "2018-09-18T01:12:26.360Z",  "created_at":  "2018-09-18T01:12:26.360Z",  "project_id":  1,  "web_url":  "http://example.com/gitlab-org/gitlab-test/snippets/41",  "raw_url":  "http://example.com/gitlab-org/gitlab-test/snippets/41/raw"  }  ] 

Get a single snippet

取得一个摘要.

GET /snippets/:id 

Parameters:

请求示例：

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

响应示例：

{  "id":  1,  "title":  "test",  "file_name":  "add.rb",  "description":  "Ruby test snippet",  "visibility":  "private",  "author":  {  "id":  1,  "username":  "john_smith",  "email":  "john@example.com",  "name":  "John Smith",  "state":  "active",  "created_at":  "2012-05-23T08:00:58Z"  },  "expires_at":  null,  "updated_at":  "2012-06-28T10:52:04Z",  "created_at":  "2012-06-28T10:52:04Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/1",  "raw_url":  "http://example.com/snippets/1/raw"  } 

Single snippet contents

获取单个代码段的原始内容.

GET /snippets/:id/raw 

Parameters:

请求示例：

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

响应示例：

Hello World snippet 

Snippet repository file content

以纯文本形式返回原始文件的内容.

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

Parameters:

请求示例：

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

响应示例：

Hello World snippet 

Create new snippet

创建一个新的代码段.

注意：用户必须具有创建新代码段的权限.

POST /snippets 

Parameters:

请求示例：

curl --request POST \
     --data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \
     --header 'Content-Type: application/json' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/snippets" 

响应示例：

{  "id":  1,  "title":  "This is a snippet",  "file_name":  "test.txt",  "description":  "Hello World snippet",  "visibility":  "internal",  "author":  {  "id":  1,  "username":  "john_smith",  "email":  "john@example.com",  "name":  "John Smith",  "state":  "active",  "created_at":  "2012-05-23T08:00:58Z"  },  "expires_at":  null,  "updated_at":  "2012-06-28T10:52:04Z",  "created_at":  "2012-06-28T10:52:04Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/1",  "raw_url":  "http://example.com/snippets/1/raw"  } 

Update snippet

更新现有代码段.

注意：用户必须具有更改现有代码段的权限.

PUT /snippets/:id 

Parameters:

请求示例：

curl --request PUT \
     --data '{"title": "foo", "content": "bar"}' \
     --header 'Content-Type: application/json' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/snippets/1" 

响应示例：

{  "id":  1,  "title":  "test",  "file_name":  "add.rb",  "description":  "description of snippet",  "visibility":  "internal",  "author":  {  "id":  1,  "username":  "john_smith",  "email":  "john@example.com",  "name":  "John Smith",  "state":  "active",  "created_at":  "2012-05-23T08:00:58Z"  },  "expires_at":  null,  "updated_at":  "2012-06-28T10:52:04Z",  "created_at":  "2012-06-28T10:52:04Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/1",  "raw_url":  "http://example.com/snippets/1/raw"  } 

Delete snippet

删除现有的代码段.

DELETE /snippets/:id 

Parameters:

请求示例：

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

以下是可能的返回码：

List all public snippets

列出所有公共摘要.

GET /snippets/public 

Parameters:

请求示例：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/public?per_page=2&page=1" 

响应示例：

[  {  "author":  {  "avatar_url":  "http://www.gravatar.com/avatar/edaf55a9e363ea263e3b981d09e0f7f7?s=80&d=identicon",  "id":  12,  "name":  "Libby Rolfson",  "state":  "active",  "username":  "elton_wehner",  "web_url":  "http://example.com/elton_wehner"  },  "created_at":  "2016-11-25T16:53:34.504Z",  "file_name":  "oconnerrice.rb",  "id":  49,  "title":  "Ratione cupiditate et laborum temporibus.",  "updated_at":  "2016-11-25T16:53:34.504Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/49",  "raw_url":  "http://example.com/snippets/49/raw"  },  {  "author":  {  "avatar_url":  "http://www.gravatar.com/avatar/36583b28626de71061e6e5a77972c3bd?s=80&d=identicon",  "id":  16,  "name":  "Llewellyn Flatley",  "state":  "active",  "username":  "adaline",  "web_url":  "http://example.com/adaline"  },  "created_at":  "2016-11-25T16:53:34.479Z",  "file_name":  "muellershields.rb",  "id":  48,  "title":  "Minus similique nesciunt vel fugiat qui ullam sunt.",  "updated_at":  "2016-11-25T16:53:34.479Z",  "project_id":  null,  "web_url":  "http://example.com/snippets/48",  "raw_url":  "http://example.com/snippets/49/raw",  "visibility":  "public"  }  ] 

Get user agent details

在 GitLab 9.4 中引入 .

注意：仅适用于管理员.

GET /snippets/:id/user_agent_detail 

请求示例：

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

响应示例：

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