OpenAPI 使用入门¶

AtomGit API 提供了强大的功能，允许开发者通过编程方式与 AtomGit 上的资源进行交互。本文档将向您介绍如何使用 AtomGit API，包括有效的 API 请求、认证方式、状态码、分页、路径参数等方面的内容。

面向 AI Agent 和自动化工具¶

如果您是 AI Agent 或自动化工具，建议按以下顺序获取信息，无需逐页解析 HTML：

• AtomGit API 索引与摘要（llms.txt）：全部接口的名称、描述和文档链接索引。查找接口时先读取此文件。
• AtomGit API JSON 规范：完整的机器可读接口规范（OpenAPI 3.0.3）。生成调用参数或接入工具时读取此文件。
• AtomGit API 同一规范的 Markdown 版：完整的机器可读接口规范 Markdown 版。想喂给 Agent 就用这个地址。

API Host 与多域名支持¶

AtomGit API 支持多个访问域名，功能与接口完全一致，可按网络环境就近选择：

两个 Host 下的接口路径、参数、认证方式和响应结构完全相同，无需修改任何代码即可切换。例如以下两个请求等价： 例如以下两个请求等价：

curl "https://api.atomgit.com/api/v5/users/{username}"

curl "https://api.gitcode.com/api/v5/users/{username}"

注意：本文档示例统一使用 https://api.atomgit.com，如你使用 GitCode 域名，只需替换 Host 部分。建议在代码中将 Host 配置为环境变量，便于切换与迁移。

有效的 API 请求¶

对 AtomGit API 发起请求必须包括 api 和 API 版本，当前可用的版本为 /api/v5。

以下是对 AtomGit API 发起请求的基本示例：

curl "https://api.atomgit.com/api/v5/users/{username}"

认证¶

大多数 AtomGit API 请求需要认证，或者在未提供认证时只返回公共数据。每个接口的文档都会指明是否需要认证。

你可以通过个人访问令牌使用 AtomGit API 进行认证。

如果认证信息无效或缺失，AtomGit 会返回带有 401 状态码的错误信息：

{
  "message": "401 Unauthorized"
}

Authorization¶

你可以通过 Authorization 头中传递个人访问令牌来使用 API 进行认证。

请求头中的个人访问令牌的示例：

curl --location 'https://api.atomgit.com/api/v5/user' \
--header 'Authorization: Bearer {your-token}'

PRIVATE-TOKEN¶

你可以通过 PRIVATE-TOKEN 头中传递个人访问令牌来使用 API 进行认证。

请求头中的个人访问令牌的示例：

curl --location 'https://api.atomgit.com/api/v5/user' \
--header 'PRIVATE-TOKEN: {your-token}'

access_token¶

你可以通过 access_token query 传递个人访问令牌来使用 API 进行认证。

query 中的个人访问令牌的示例：

curl  "https://api.atomgit.com/api/v5/users/{username}?access_token={your-token}"

状态码¶

AtomGit API 旨在根据上下文和操作返回不同的状态码。这样，如果请求导致错误，你可以了解出了什么问题。

下表概述了 AtomGit API 功能的一般行为：

下表显示了 AtomGit API 请求可能的返回代码：