获取仓库许可协议¶

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

该接口用于获取指定仓库的许可协议，返回协议文件的名称、路径、大小、访问地址、文件内容及编码方式，并附带许可协议的SPDX标识符，方便用户查看仓库的开源许可信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)

响应参数¶

字段	类型	必返	可为空	说明
`name`	string	是	—	许可协议文件名称
`path`	string	是	—	许可协议文件路径
`size`	integer	是	—	文件大小
`url`	string	是	—	文件访问 URL
`html_url`	string	是	—	文件在网页端的访问 URL
`content`	string	是	—	文件内容
`encoding`	string	是	—	文件内容编码方式
`license`	object	是	—	许可协议信息

license 对象

字段	类型	必返	可为空	说明
`license.spdx_id`	string	是	—	许可协议的 SPDX 标识符

失败响应¶

该接口无业务失败响应。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）。该接口允许匿名访问，请求示例未携带访问令牌；如有需要，也可在查询参数中携带 <token>（AtomGit 用户访问令牌）。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license' \
  -H 'Accept: application/json'

JavaScript¶

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

print(resp.json())

响应示例¶

状态码： 200

{
  "name": "LICENSE",
  "path": "LICENSE",
  "size": 1073,
  "url": "https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license",
  "html_url": "https://api.atomgit.com/{owner}/{repo}/blob/main/LICENSE",
  "content": "<base64 编码的文件内容>",
  "encoding": "base64",
  "license": {
    "spdx_id": "MIT"
  }
}

错误码¶

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

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