Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Gitignore

使用 REST API 获取可用于忽略文件和目录的 .gitignore 模板。

关于 gitignore

通过 API 在 your GitHub Enterprise Server instance 上创建新存储库时,可以指定一个 .gitignore 模板在创建后应用于存储库。 可以使用 REST API 从 GitHub Enterprise Server .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说明
200

OK

304

Not modified

Code samples

get/gitignore/templates
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/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
名称, Type, 说明
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
名称, Type, 说明
namestringRequired

HTTP response status codes

Status code说明
200

OK

304

Not modified

Code samples

get/gitignore/templates/{name}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/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" }