Agent Skills
返回列表
GitCode API 使用指南

GitCode API 使用指南

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_f6d71f82/gitcode-api。

技能介绍

解决的具体问题

在工程团队中,调用 GitCode REST 接口通常面临两个痛点:一是手写 httpx 或 requests 请求时,响应结构不统一、属性访问繁琐;二是 API 密钥(如 GITCODE_ACCESS_TOKEN)在传递过程中容易泄露,且缺乏统一的异步与同步双栈支持。本技能提供一个基于 Python 的 SDK 使用规范,帮助开发者以结构化的方式操作 GitCode 的仓库、分支、Issues、PR 等核心资源,同时处理令牌加密与解密逻辑。

核心能力与关键步骤

  • 资源组调用:SDK 采用类似 OpenAI 客户端的层级设计。从顶层 GitCode 或 AsyncGitCode 对象出发,通过 client.repos、client.pulls 等资源组调用具体方法(如 client.repos.get())。
  • 双栈与上下文管理:支持同步与异步调用,推荐使用 with 上下文管理器,确保底层 httpx 客户端自动关闭,避免连接泄漏。
  • 响应对象:API 返回的是支持属性访问的轻量级对象,而非纯字典,简化了数据解析。
  • 令牌安全:默认读取 GITCODE_ACCESS_TOKEN 环境变量。若令牌已加密,可通过构造参数传入 decrypt 密钥,SDK 会在认证前自动解码,避免明文暴露。
  • 企业网络适配:针对 SSL 自签名证书报错,支持传入自定义 httpx 客户端并指定 verify 参数,类似于配置 REQUESTS_CA_BUNDLE。

适用边界与注意点

  • 非类型化请求/响应:与 OpenAI SDK 不同,本 SDK 侧重于 GitCode REST 资源,未提供强类型的 request/response 对象,开发者需依赖文档或 method_signature(name) 进行运行时检查。
  • 仓库作用域:若未在全局客户端设置 owner 和 repo,在调用特定仓库的资源方法时,必须在每个方法中显式传入这两个参数。
  • 脚本弃用:附带的 scripts/gitcode_api_cli.py 已被弃用,生产环境应优先使用内置 CLI 或环境变量管理令牌,避免将密钥暴露在命令行参数中。

使用场景

  • 在 CI 中读取 GitCode 仓库信息和指定文件内容,用于核对构建配置。
  • 发布前查询分支、提交和差异,确认变更是否具备合并条件。
  • 用 Python 自动列出、创建并合并 GitCode 的 Issues 与 PR。
  • 企业内网访问 GitCode 报自签名证书错误时,配置自定义 `httpx` CA。

适合人员

  • 需要把 GitCode 仓库、Issues 和 PR 查询写进自动化脚本的工程师。
  • 希望用类 OpenAI 客户端结构调用 GitCode 接口的后端开发者。
  • 需要在 CI 中使用加密 `GITCODE_ACCESS_TOKEN` 的运维工程师。
  • 负责处理企业内网自签名证书访问 GitCode 的 SRE。