快速开始¶

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 配置为环境变量，便于切换与迁移。

发起第一个请求¶

1. 在个人访问令牌页面创建令牌。

2. 将令牌保存为环境变量：

   export ATOMGIT_TOKEN=<你的令牌>
   

3. 查询公开用户的资料。该接口无需鉴权：

   curl 'https://api.atomgit.com/api/v5/users/<username>'
   

4. 列出仓库中处于开启状态的 Issue：

   curl 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues?state=open&per_page=20' \
     -H "Authorization: Bearer $ATOMGIT_TOKEN"