Skip to main content

Gitignore

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

关于 Gitignore API

当您通过 API 在 您的 GitHub Enterprise Server 实例 上创建新仓库时,您可以指定一个 .gitignore 模板 在创建时应用于仓库。 .gitignore 模板 API 可列出 GitHub Enterprise Server .gitignore 仓库并从中获取模板。

gitignore 的自定义媒体类型

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

application/vnd.github.VERSION.raw

更多信息请参阅“媒体类型”。

Get all gitignore templates

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

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

代码示例

get/gitignore/templates
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/gitignore/templates

Response

Status: 200
[ "Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "C", "C++" ]

Get a gitignore template

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

参数

标头
名称, 类型, 描述
acceptstring

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

路径参数
名称, 类型, 描述
namestring必选

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

代码示例

get/gitignore/templates/{name}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <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" }