OpenAPI 使用入门

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

有效的 API 请求

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

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

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

认证

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

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

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

{
  "message": "401 Unauthorized"
}

Authorization

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

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

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

PRIVATE-TOKEN

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

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

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

access_token

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

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

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

状态码

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

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

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