跳至主要内容
REST API 现在已版本化。 有关更多信息,请参阅 "关于 API 版本控制."

用于 gitignore 的 REST API 端点

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

关于 gitignore

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

获取所有 gitignore 模板

列出所有可用于在 创建仓库 时作为选项传递的模板。

用于“获取所有 gitignore 模板”的细粒度访问令牌

此端点支持以下细粒度令牌类型

细粒度令牌不需要任何权限。

“获取所有 gitignore 模板”的 HTTP 响应状态码

状态码描述
200

OK

304

未修改

“获取所有 gitignore 模板”的代码示例

请求示例

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

响应

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

获取 gitignore 模板

获取 gitignore 模板的内容。

此端点支持以下自定义媒体类型。有关更多信息,请参阅“媒体类型”。

  • application/vnd.github.raw+json:返回原始 .gitignore 内容。

“获取 gitignore 模板”的细粒度访问令牌

此端点支持以下细粒度令牌类型

细粒度令牌不需要任何权限。

“获取 gitignore 模板”的参数

标头
名称、类型、描述
accept string

建议设置为 application/vnd.github+json

路径参数
名称、类型、描述
name string 必需

“获取 gitignore 模板”的 HTTP 响应状态码

状态码描述
200

OK

304

未修改

“获取 gitignore 模板”的代码示例

请求示例

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

响应

状态: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" }