Project badges API

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

• Placeholder tokens
• List all badges of a project
• Get a badge of a project
• Add a badge to a project
• Edit a badge of a project
• Remove a badge from a project
• Preview a badge from a project

Project badges API

在 GitLab 10.6 中引入 .

Placeholder tokens

徽章支持占位符，这些占位符将在链接和图像 URL 中被实时替换. 允许的占位符为：

• ％{project_path} ：将被项目路径替换.
• ％{project_id} ：将被项目 ID 取代.
• ％{default_branch} ：将被项目默认分支替换.
• ％{commit_sha} ：将被上一个项目的提交 sha 取代.

List all badges of a project

获取项目徽章及其组徽章的列表.

GET /projects/:id/badges

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

响应示例：

[  {  "name":  "Coverage",  "id":  1,  "link_url":  "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",  "image_url":  "https://shields.io/my/badge",  "rendered_link_url":  "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",  "rendered_image_url":  "https://shields.io/my/badge",  "kind":  "project"  },  {  "name":  "Pipeline",  "id":  2,  "link_url":  "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",  "image_url":  "https://shields.io/my/badge",  "rendered_link_url":  "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",  "rendered_image_url":  "https://shields.io/my/badge",  "kind":  "group"  },  ]

Get a badge of a project

获取项目的徽章.

GET /projects/:id/badges/:badge_id

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

响应示例：

{  "id":  1,  "link_url":  "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",  "image_url":  "https://shields.io/my/badge",  "rendered_link_url":  "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",  "rendered_image_url":  "https://shields.io/my/badge",  "kind":  "project"  }

Add a badge to a project

将徽章添加到项目.

POST /projects/:id/badges

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" "https://gitlab.example.com/api/v4/projects/:id/badges"

响应示例：

{  "id":  1,  "link_url":  "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",  "image_url":  "https://shields.io/my/badge1",  "rendered_link_url":  "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",  "rendered_image_url":  "https://shields.io/my/badge1",  "kind":  "project"  }

Edit a badge of a project

更新项目的徽章.

PUT /projects/:id/badges/:badge_id

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

响应示例：

{  "id":  1,  "link_url":  "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",  "image_url":  "https://shields.io/my/badge",  "rendered_link_url":  "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",  "rendered_image_url":  "https://shields.io/my/badge",  "kind":  "project"  }

Remove a badge from a project

从项目中删除徽章. 使用此端点将仅删除项目的标志.

DELETE /projects/:id/badges/:badge_id

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"

Preview a badge from a project

返回解析占位符插值后的link_url和image_url最终 URL.

GET /projects/:id/badges/render

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"

响应示例：

{  "link_url":  "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",  "image_url":  "https://shields.io/my/badge",  "rendered_link_url":  "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",  "rendered_image_url":  "https://shields.io/my/badge",  }