gitignore 的 REST API 终结点

关于 gitignore

通过 API 在 GitHub 上创建新存储库时，可以指定一个 .gitignore 模板在创建后应用于存储库。可以使用 REST API 从 GitHub .gitignore 存储库中获取 .gitignore 模板。

Get all gitignore templates

List all templates available to pass as an option when creating a repository.

“Get all gitignore templates”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌不需要任何权限。

如果仅请求公共资源，则无需身份验证即可使用此终结点。

“Get all gitignore templates”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`304`	Not modified

“Get all gitignore templates”的示例代码

请求示例

get/gitignore/templates

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/gitignore/templates

Response

Status: 200

[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

Get a gitignore template

Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw .gitignore contents.

“Get a gitignore template”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌不需要任何权限。

如果仅请求公共资源，则无需身份验证即可使用此终结点。

“Get a gitignore template”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`name` string 必须

“Get a gitignore template”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`304`	Not modified

“Get a gitignore template”的示例代码

请求示例

get/gitignore/templates/{name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/gitignore/templates/NAME

Response

Status: 200

{
  "name": "C",
  "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
}