跳转至

判断用户是否为仓库成员

GET /api/v5/repos/{owner}/{repo}/collaborators/{username}

该接口用于判断指定用户是否为指定仓库的成员,通过仓库所属空间地址、仓库路径和用户名进行查询;若该用户为仓库成员则返回 204 状态码,否则返回 404 状态码。

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址path)
repo path string 是 仓库路径(path)
username path string 是 用户名(username/login)
access_token query string 是 用户授权码

响应参数

接口成功时(用户是仓库成员)返回 204 No Content,响应体为空。当用户不是仓库成员时返回 404 Not Found,响应体为:

字段 类型 必返 可为空 说明
message string 是 否 错误信息,值为 404 Not Found

失败响应

调用方需要知道失败长什么样才能写错误处理。本接口唯一的业务失败响应是「用户不是仓库成员」,此时返回 404。

404 用户不是仓库成员

{
  "message": "404 Not Found"
}

HTTP 响应状态码

状态码 说明
204 用户是仓库成员(No Content,响应体为空)
404 用户不是仓库成员(Not Found)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)

请求示例

参数说明

示例中的占位符说明:

<owner> 替换为仓库所属空间地址(企业、组织或个人的地址path); <repo> 替换为仓库路径(path); <username> 替换为用户名(username/login); <token> 替换为你的 AtomGit 用户访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators/<username>?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators/<username>?access_token=<token>",
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (response.status === 204) {
  console.log("用户是仓库成员");
} else if (response.status === 404) {
  console.log("用户不是仓库成员");
} else {
  throw new Error(`请求失败: ${response.status}`);
}

Python

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/collaborators/<username>",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)

if resp.status_code == 204:
    print("用户是仓库成员")
elif resp.status_code == 404:
    print("用户不是仓库成员")
else:
    resp.raise_for_status()

响应示例

状态码: 204

用户是仓库成员,响应体为空(No Content)。

状态码: 404

用户不是仓库成员:

{
  "message": "404 Not Found"
}

错误码

错误码 说明
204 用户是仓库成员(No Content)
404 用户不是仓库成员(Not Found)
401 未认证或凭证无效(缺少/无效的访问凭证)
403 禁止访问
429 请求过于频繁,触发限流
500 系统内部错误

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