跳转至

获取授权用户的Namespace

GET /api/v5/user/namespace

用户调用此接口,进行获取授权用户的一个 Namespace操作.

访问令牌支持说明

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

是否允许匿名访问

此接口不允许匿名访问

请求参数

参数名 位置 类型 必填 说明
access_token query string 是 用户授权码
path query string 是 Namespace 路径(path)

响应参数

字段 类型 必返 可为空 说明
id integer 是 否 Namespace 的 ID
path string 是 否 Namespace 的路径(path)
name string 是 否 Namespace 名称
html_url string 是 否 Namespace 的访问地址
type string 是 否 Namespace 类型,枚举:user(用户)/ group(组织)

失败响应

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 path 不能为空",
  "field": "path"
}

401 未认证

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

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

HTTP 响应状态码

状态码 说明
200 成功(OK)
400 参数错误(Bad request)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)
404 未找到(Not found)
500 系统内部错误(Internal server error)

请求示例

参数说明

<path> 替换为要查询的 Namespace 路径(企业、组织或个人的地址 path);<token> 替换为你的 AtomGit 用户访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/user/namespace?access_token=<token>&path=<path>' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const params = new URLSearchParams({
  access_token: "<YOUR-TOKEN>",
  path: "<namespace-path>",
});

const response = await fetch(`https://api.atomgit.com/api/v5/user/namespace?${params}`, {
  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/v5/user/namespace",
    params={
        "access_token": "<YOUR-TOKEN>",
        "path": "<namespace-path>",
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{
  "id": 138108,
  "path": "xiaogang_test",
  "name": "aaasfd/sda/fsdaf/sdfsa",
  "html_url": "https://api.atomgit.com/xiaogang_test",
  "type": "group"
}

错误码

错误码 说明
401 未认证或凭证无效(缺少/无效的访问凭证)
400 参数错误或请求无法解析
403 禁止访问
404 请求路径不存在
500 系统内部错误

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