上传图片¶

POST /api/v5/repos/{owner}/{repo}/img/upload

该接口用于将图片上传至指定仓库，请求时在请求体中提交以 base64 编码的图片文件内容及文件名，上传成功后返回图片的相对路径和完整访问地址，便于后续引用图片资源。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

请求体为 application/json，字段序列化采用下划线命名（snake_case），字段含义如下：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "body": {
      "description": "文件内容 base64 形式（去掉 Data URL 前缀）；限制 20M",
      "type": "string"
    },
    "file_name": {
      "description": "文件名",
      "type": "string"
    }
  },
  "required": ["body", "file_name"]
}

响应参数¶

响应体为 application/json，字段序列化采用下划线命名（snake_case）。

字段	类型	必返	可为空	说明
`success`	boolean	是	否	是否上传成功
`path`	string	是	是	上传后的相对路径（如 `uploads/xxx/test.txt`），可能为 `null`
`full_path`	string	是	是	上传后的完整访问地址（`https://atomgit.com/...`），可能为 `null`

失败响应¶

以下失败响应为平台统一的错误结构，实际错误字段名以后端返回为准。

400 参数错误

{
  "error_code": 400,
  "error_code_name": "PARAMETER_ERROR",
  "error_message": "文件内容不能为空"
}

401 未认证

{
  "error_code": 401,
  "error_code_name": "UNAUTHORIZED",
  "error_message": "token not found"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（请求体解析失败或参数校验不通过）
`401`	需要认证（缺少或无效的访问令牌）
`403`	禁止访问（无权限）
`429`	请求过于频繁，触发限流
`500`	系统内部错误

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址 path（企业、组织或个人的地址 path）；
<repo> 替换为仓库路径（path）；
<token> 替换为你的 AtomGit 用户访问令牌；
<base64_content> 替换为图片文件内容的 base64 编码（去掉 Data URL 前缀）。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/img/upload?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "<base64_content>",
    "file_name": "test.png"
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/img/upload?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      body: "<base64_content>",
      file_name: "test.png",
    }),
  }
);

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

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

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/img/upload",
    params={"access_token": "<token>"},
    json={
        "body": "<base64_content>",
        "file_name": "test.png",
    },
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "success": true,
  "path": "uploads/4c98ad75-729f-49ce-82ab-b41c1f7ffc90/test3.txt",
  "full_path": "https://api.atomgit.com/xiaogang/test/attachment/uploads/4c98ad75-729f-49ce-82ab-b41c1f7ffc90/test3.txt"
}

错误码¶

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

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