{{< details >}}

  • Tier: 基础版, 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署

{{< /details >}}

使用此 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}: 被项目的最后标签替换。

因为这些端点不在项目上下文中，所以用于替换占位符的信息来自于按创建日期排序的第一个群组项目。如果群组没有任何项目，则返回带有占位符的原始 URL。

列出群组的所有徽章

获取群组徽章的列表。

GET /groups/:id/badges
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
name string 否 要返回的徽章名称（区分大小写）。 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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": "group"
  }
]

获取群组的一个徽章

获取群组的一个徽章。

GET /groups/:id/badges/:badge_id
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
badge_id integer 是 徽章 ID 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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": "group"
}

添加徽章到群组

添加徽章到群组。

POST /groups/:id/badges
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
link_url string 是 徽章链接的 URL
image_url string 是 徽章图片的 URL
name string 否 徽章名称 
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&name=mybadge&position=0" \
     "https://gitlab.example.com/api/v4/groups/:id/badges"

示例响应：

{
  "id": 1,
  "name": "mybadge",
  "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": "group"
}

编辑群组的一个徽章

更新群组的一个徽章。

PUT /groups/:id/badges/:badge_id
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
badge_id integer 是 徽章 ID
link_url string 否 徽章链接的 URL
image_url string 否 徽章图片的 URL
name string 否 徽章名称 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

示例响应：

{
  "id": 1,
  "name": "mybadge",
  "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": "group"
}

从群组中移除徽章

从群组中移除徽章。

DELETE /groups/:id/badges/:badge_id
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
badge_id integer 是 徽章 ID 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

预览群组的徽章

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

GET /groups/:id/badges/render
属性 类型 必需 描述
id integer/string 是 群组的 ID 或 URL 编码路径
link_url string 是 徽章链接的 URL
image_url string 是 徽章图片的 URL 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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"
}