搜索用户¶

GET /api/v5/search/users

用户调用此接口，根据关键字搜索用户。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`q`	query	string	是	搜索关键字
`access_token`	query	string	否	用户授权码
`page`	query	integer	否	当前的页码，最大为 100
`per_page`	query	integer	否	每页的数量，最大为 50
`sort`	query	string	否	排序字段，`joined_at`（注册时间），默认为最佳匹配
`order`	query	string	否	排序顺序（默认：`desc`）

响应参数¶

字段	类型	必返	可为空	说明
`avatar_url`	string	是	—	用户头像地址
`created_at`	string	是	—	用户创建时间
`html_url`	string	是	—	用户主页地址
`id`	string	是	—	用户 ID
`login`	string	是	—	用户登录名
`name`	string	是	—	用户名称

Note: 响应体是一个用户对象数组，每个元素包含上表中的字段。

失败响应¶

该接口无业务失败响应。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在
`500`	系统内部错误

请求示例¶

参数说明¶

<keyword> 替换为要搜索的关键字；page 为当前页码（最大 100）；per_page 为每页数量（最大 50）； sort 为排序字段（joined_at 表示按注册时间，默认为最佳匹配）；order 为排序顺序（默认 desc）。

本接口允许匿名访问，无需携带访问令牌；如需身份认证，可在查询参数中追加 access_token=<token>。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/search/users?q=<keyword>&page=1&per_page=20&sort=joined_at&order=desc' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const url = new URL("https://api.atomgit.com/api/v5/search/users");
url.searchParams.set("q", "<keyword>");
url.searchParams.set("page", "1");
url.searchParams.set("per_page", "20");
url.searchParams.set("sort", "joined_at");
url.searchParams.set("order", "desc");

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

params = {
    "q": "<keyword>",
    "page": 1,
    "per_page": 20,
    "sort": "joined_at",
    "order": "desc",
}

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "avatar_url": "https://api.atomgit.com/avatar/wu_com.png",
    "created_at": "2024-11-15T00:00:00+08:00",
    "html_url": "https://api.atomgit.com/wu_com",
    "id": "25235036",
    "login": "wu_com",
    "name": "wu_com"
  }
]

错误码¶

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

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