Gitignore

Используйте REST API для получения .gitignore шаблонов, которые можно использовать для пропуска файлов и каталогов.

О gitignore

При создании нового репозитория в GitHub.com с помощью API можно указать шаблон .gitignore для применения к репозиторию при его создании. С помощью REST API можно получить шаблоны .gitignore из репозитория gitignore GitHub.

При получении шаблона gitignore можно использовать application/vnd.github.raw пользовательский тип носителя. Дополнительные сведения см. в разделе Типы носителей.

Get all gitignore templates

Работает с GitHub Apps

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

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK
`304`	Not modified

Примеры кода

get/gitignore/templates

curl \
  -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

Работает с GitHub Apps

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

Параметры

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`name`stringRequired

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK
`304`	Not modified

Примеры кода

get/gitignore/templates/{name}

curl \
  -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"
}