ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

Gitignore

ここには以下の内容があります:

API を介して新しい GitHub リポジトリを作成する場合、作成時にリポジトリに適用する .gitignore テンプレートを指定できます。 .gitignore テンプレート API は、GitHub の .gitignore リポジトリからテンプレートを一覧表示してフェッチします。

gitignore のカスタムメディアタイプ

gitignore テンプレートを取得するときに、このカスタムメディアタイプを使用できます。

application/vnd.github.VERSION.raw

詳しい情報については、「メディアタイプ」を参照してください。

Get all gitignore templates

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

get /gitignore/templates

コードサンプル

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/gitignore/templates
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates')

Response

Status: 200 OK
[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

Not modified

Status: 304 Not Modified

Notes


Get a gitignore template

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

get /gitignore/templates/{name}

パラメータ

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended.

name string path

コードサンプル

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/gitignore/templates/NAME
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates/{name}', {
  name: 'name'
})

Default response

Status: 200 OK
{
  "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"
}

Not modified

Status: 304 Not Modified

Notes


Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.