获取标签列表¶

GET /api/v8/enterprises/{enterprise}/labels

获取企业（组织）下的标签列表，支持关键词搜索、分页与排序。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`enterprise`	path	string	是	仓库所属空间地址（企业、组织或个人的地址path）
`sort`	query	string	否	排序字段，枚举：`created_at` / `updated_at` / `name`；默认 `updated_at`
`direction`	query	string	否	排序方向，枚举：`asc` / `desc`；默认 `desc`
`search`	query	string	否	关键词查询
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	否	标签id
`name`	string	是	否	标签名称
`color`	string	是	否	标签颜色
`url`	string	否	是	标签url
`repository_id`	integer	否	是	仓库id
`created_at`	string	否	是	创建时间
`updated_at`	string	否	是	更新时间

Note: 响应体为标签对象数组，上表字段为数组中每个元素的字段。

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数不合法"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

404 企业不存在

{
  "error": "not_found",
  "message": "企业不存在"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）
`429`	请求过于频繁（Too many requests）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<enterprise> 替换为企业/组织的路径名（企业、组织或个人的地址 path）；本接口允许匿名访问，也可在查询参数中携带 access_token（用户授权码）进行认证。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v8/enterprises/<enterprise>/labels?sort=updated_at&direction=desc&page=1&per_page=20' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v8/enterprises/<enterprise>/labels?sort=updated_at&direction=desc&page=1&per_page=20", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v8/enterprises/<enterprise>/labels",
    params={
        "sort": "updated_at",
        "direction": "desc",
        "page": 1,
        "per_page": 20,
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 382218,
    "name": "bug",
    "color": "#e03529",
    "url": "https://api.atomgit.com/enterprises/example/labels/382218",
    "repository_id": 1,
    "created_at": "2024-10-09T18:37:00",
    "updated_at": "2024-10-09T18:37:00"
  }
]

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc