Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

Gitignore

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

关于 gitignore

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

获取 gitignore 模板时,你可以使用 application/vnd.github.raw 自定义媒体类型。 有关详细信息,请参阅“媒体类型”。

Get all gitignore templates

适用于 GitHub Apps

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

“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

适用于 GitHub Apps

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

“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" }