跳转至

获取企业所有的标签

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

该接口用于获取指定企业的全部标签,支持分页查询,每页数量最大为 100。返回结果为标签列表,包含标签 ID、名称、颜色、创建时间与更新时间等信息,可用于企业标签的管理与展示。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
enterprise path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
access_token query string 否 用户授权码
page query string 否 当前的页码
per_page query string 否 每页的数量,最大为 100,默认 100

响应参数

响应体为一个 JSON 数组,数组元素为标签对象,字段如下:

字段 类型 必返 可为空 说明
id integer 是 — 标签 ID
name string 是 — 标签名称
color string 是 — 标签颜色
created_at string 是 — 标签创建时间
updated_at string 是 — 标签更新时间

失败响应

该接口在参数错误、未认证或资源不存在等情况下会返回非 200 状态码(如 400、401、404)。错误响应体的具体字段名以后端实际返回为准。

HTTP 响应状态码

状态码 说明
200 成功(OK)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 资源不存在(Not found)
500 系统内部错误(Internal server error)

请求示例

参数说明

<enterprise> 替换为仓库所属空间地址(企业、组织或个人的地址 path);<token> 替换为你的 AtomGit 用户访问令牌(可选,接口允许匿名访问)。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/enterprises/<enterprise>/labels?access_token=<token>' \
  -H 'Accept: application/json'

接口允许匿名访问,access_token 为可选参数,也可以省略。

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const enterprise = "<enterprise>";
const token = "<token>"; // 可选,接口允许匿名访问

const url = `https://api.atomgit.com/api/v5/enterprises/${enterprise}/labels${
  token ? `?access_token=${token}` : ""
}`;

const response = await fetch(url, {
  headers: {
    "Accept": "application/json",
  },
});

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

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

Python

import requests

enterprise = "<enterprise>"
token = "<token>"  # 可选,接口允许匿名访问

params = {}
if token:
    params["access_token"] = token

resp = requests.get(
    f"https://api.atomgit.com/api/v5/enterprises/{enterprise}/labels",
    params=params,
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": 471,
    "name": "aaaaa",
    "color": "#2865E0",
    "created_at": "2024-11-22T11:25:36.769+08:00",
    "updated_at": "2024-11-22T11:25:36.769+08:00"
  }
]

错误码

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

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