跳转至

查看仓库的Forks

GET /api/v5/repos/{owner}/{repo}/forks

该接口用于查看指定仓库的所有 Fork(分叉)仓库列表,通过仓库所属空间地址和仓库路径进行查询,支持按 Fork 时间或 Star 人数排序,可按创建时间范围筛选并进行分页查询,以了解仓库的衍生版本信息。

访问令牌支持说明

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

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
repo path string 是 仓库路径(path)
sort query string 否 排序方式:按 fork 时间(newest / oldest)或 star 人数(stargazers)
page query integer 否 当前的页码
per_page query integer 否 每页的数量,最大为 100,默认 20
created_after query string 否 只返回在此时间之后创建的 fork
created_before query string 否 只返回在此时间之前创建的 fork

响应参数

响应体是一个 Fork 仓库对象数组,每个元素的结构如下:

字段 类型 必返 可为空 说明
id integer 是 否 Fork 仓库 id
full_name string 是 否 仓库完整名称,如 wangwt/RuoYi
human_name string 是 否 仓库可读名称,如 wangwt / RuoYi
url string 是 否 仓库 API 地址
namespace object 是 否 仓库所属空间(命名空间)信息
description string 是 是 仓库描述,可能为空
status string 是 是 仓库状态,可能为空
created_at string 是 否 仓库创建时间
updated_at string 是 否 仓库更新时间
owner object 是 否 仓库所有者信息
pushed_at string 是 是 最近推送时间
parent object 是 否 源仓库信息(该 fork 的来源仓库)
private boolean 是 否 是否为私有仓库
public boolean 是 否 是否为公开仓库

namespace 对象

字段 类型 必返 可为空 说明
namespace.id integer 是 否 空间 id
namespace.type string 是 否 空间类型,如 personal
namespace.name string 是 否 空间名称
namespace.path string 是 否 空间地址 path
namespace.html_url string 是 否 空间页面地址

owner 对象

字段 类型 必返 可为空 说明
owner.id integer 是 否 所有者用户 id
owner.login string 是 否 用户登录名
owner.name string 是 否 用户名称

parent 对象

字段 类型 必返 可为空 说明
parent.id integer 是 否 源仓库 id
parent.full_name string 是 否 源仓库完整名称
parent.human_name string 是 否 源仓库可读名称
parent.url string 是 否 源仓库 API 地址
parent.namespace object 是 否 源仓库所属空间信息

parent.namespace 对象

字段 类型 必返 可为空 说明
parent.namespace.id integer 是 否 空间 id
parent.namespace.type string 是 否 空间类型,如 personal
parent.namespace.name string 是 否 空间名称
parent.namespace.path string 是 否 空间地址 path
parent.namespace.html_url string 是 否 空间页面地址

失败响应

以下为该接口可能返回的失败响应示例(错误字段名以后端实际返回为准)。

400 参数错误

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

401 未认证

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

404 仓库不存在

{
  "error": "not_found",
  "message": "仓库不存在"
}

HTTP 响应状态码

状态码 说明
200 成功(OK)
304 未修改(Not modified)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)

请求示例

本接口允许匿名访问,示例中未携带访问令牌;你也可以在调用时附带 AtomGit 用户访问令牌。

参数说明

<owner> 替换为仓库所属空间地址 path(企业、组织或个人的地址 path);<repo> 替换为仓库路径(path)。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/forks?sort=stargazers&per_page=20' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/forks?sort=stargazers&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/v5/repos/<owner>/<repo>/forks",
    params={"sort": "stargazers", "per_page": 20},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": 567682,
    "full_name": "wangwt/RuoYi",
    "human_name": "wangwt / RuoYi",
    "url": "https://api.atomgit.com/api/v5/repos/wangwt/RuoYi",
    "namespace": {
      "id": 153748,
      "type": "personal",
      "name": "wangwt",
      "path": "wangwt",
      "html_url": "https://api.atomgit.com/wangwt"
    },
    "description": "",
    "status": "",
    "created_at": "2024-07-29T15:42:45.149+08:00",
    "updated_at": "2024-07-29T15:42:45.149+08:00",
    "owner": {
      "id": 970,
      "login": "wangwt",
      "name": "wangwt"
    },
    "pushed_at": "2024-11-08T16:24:10.576+08:00",
    "parent": {
      "id": 517092,
      "full_name": "xiaogang/RuoYi",
      "human_name": "xiaogang / RuoYi",
      "url": "https://api.atomgit.com/api/v5/repos/xiaogang/RuoYi",
      "namespace": {
        "id": 137117,
        "type": "personal",
        "name": "xiaogang",
        "path": "xiaogang",
        "html_url": "https://api.atomgit.com/xiaogang"
      }
    },
    "private": false,
    "public": true
  }
]

错误码

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

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