Help us learn about your current experience with the documentation. Take the survey.

项目徽章 API

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

使用此 API 来管理和查看项目徽章。

徽章可以包含占位符，这些占位符会同时替换在链接和图片 URL 中。可用的占位符有：

%{project_path}: 替换为项目路径。
%{project_title}: 替换为项目标题。
%{project_name}: 替换为项目名称。
%{project_id}: 替换为项目 ID。
%{project_namespace}: 替换为项目的命名空间完整路径。
%{group_name}: 替换为项目顶级组的名称。
%{gitlab_server}: 替换为项目所在服务器的名称。
%{gitlab_pages_domain}: 替换为托管 GitLab Pages 的域名。
%{default_branch}: 替换为项目的默认分支。
%{commit_sha}: 替换为项目的最后一次提交的 SHA。
%{latest_tag}: 替换为项目的最后一个标签。

列出项目的所有徽章

获取一个项目的徽章及其组的徽章列表。

GET /projects/:id/badges

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`name`	string	no	要返回的徽章名称（区分大小写）。

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/badges?name=Coverage"

示例响应：

[
  {
    "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=main",
    "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=main",
    "rendered_image_url": "https://shields.io/my/badge",
    "kind": "group"
  }
]

获取项目的单个徽章

获取一个项目的徽章。

GET /projects/:id/badges/:badge_id

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`badge_id`	integer	yes	徽章 ID

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

示例响应：

{
  "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=main",
  "rendered_image_url": "https://shields.io/my/badge",
  "kind": "project"
}

向项目添加徽章

向项目添加一个徽章。

POST /projects/:id/badges

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`link_url`	string	yes	徽章链接的 URL
`image_url`	string	yes	徽章图片的 URL
`name`	string	no	徽章名称

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

示例响应：

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

编辑项目的徽章

更新一个项目的徽章。

PUT /projects/:id/badges/:badge_id

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`badge_id`	integer	yes	徽章 ID
`link_url`	string	no	徽章链接的 URL
`image_url`	string	no	徽章图片的 URL
`name`	string	no	徽章名称

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

示例响应：

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

从项目中移除徽章

从项目中移除一个徽章。此端点仅会移除项目徽章。

DELETE /projects/:id/badges/:badge_id

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`badge_id`	integer	yes	徽章 ID

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

预览项目的徽章

返回在解析占位符替换后，link_url 和 image_url 的最终 URL 样式。

GET /projects/:id/badges/render

属性	类型	是否必需	描述
`id`	integer or string	yes	项目的 ID 或 URL 编码的项目路径
`link_url`	string	yes	徽章链接的 URL
`image_url`	string	yes	徽章图片的 URL

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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=main",
  "rendered_image_url": "https://shields.io/my/badge"
}