gitignore 用 REST API エンドポイント

gitignore について

API を介してGitHub.comに新しいリポジトリを作成するとき、.gitignore テンプレートを指定して作成時にリポジトリを適用できます。 REST API を使って、GitHub Enterprise Cloud .gitignore リポジトリから .gitignore テンプレートを取得できます。

Get all gitignore templates

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

"Get all gitignore templates" のきめ細かいアクセストークン

このエンドポイントは、次のトークンの種類で動作します:

トークンにはアクセス許可は必要ありません。

"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

Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw .gitignore contents.

"Get a gitignore template" のきめ細かいアクセストークン

このエンドポイントは、次のトークンの種類で動作します:

トークンにはアクセス許可は必要ありません。

"Get a gitignore template" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, Type, 説明
`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"
}