Gitignore

REST API を使用して、ファイルとディレクトリを無視するために使用できる .gitignore テンプレートを取得します。

gitignore について

この API を使ってお使いの GitHub Enterprise Server インスタンスに新しいリポジトリを作成する場合、作成時にリポジトリに適用する .gitignore テンプレートを指定できます。 REST API を使って、GitHub Enterprise Server .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>" \
  http(s)://HOSTNAME/api/v3/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" のパラメーター

ヘッダー
名前, 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>" \
  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"
}