REST API 现在已版本化。 更多信息,请参阅“关于 API 版本控制”。
用于 .gitignore 的 REST API 端点
使用 REST API 获取可用于忽略文件和目录的 .gitignore
模板。
关于 .gitignore
通过 API 在 GitHub 上创建新的代码仓库时,您可以指定一个 .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
响应
获取 .gitignore 模板
获取 .gitignore 模板的内容。
此端点支持以下自定义媒体类型。更多信息,请参阅“媒体类型”。
application/vnd.github.raw+json
:返回原始 .gitignore 内容。
“获取 .gitignore 模板”的细粒度访问令牌
此端点可以使用以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源,则无需身份验证即可使用此端点。
“获取 .gitignore 模板”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
name 字符串 必需 |
“获取 .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
响应