Gitignore

Gitignore API 提取可用于忽略文件和目录的 .gitignore 模板。

关于 Gitignore API

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

gitignore 的自定义媒体类型

获取 gitignore 模板时，您可以使用以下自定义媒体类型。

application/vnd.github.raw

有关详细信息，请参阅“媒体类型”。

Get all gitignore templates

Works with GitHub Apps

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

HTTP response status codes

Status code	Description
`200`	OK
`304`	Not modified

Code samples

get/gitignore/templates

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/gitignore/templates

Response

Status: 200

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

Get a gitignore template

Works with GitHub Apps

The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.

Parameters

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`name`stringRequired

HTTP response status codes

Status code	Description
`200`	OK
`304`	Not modified

Code samples

get/gitignore/templates/{name}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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"
}