Gitignore

Use a API REST para obter modelos .gitignore que podem ser usados para ignorar arquivos e diretórios.

Sobre o gitignore

Quando você cria um repositório no GitHub.com por meio da API, você pode especificar um modelo .gitignore para aplicá-lo ao repositório após a criação. Você pode usar a API REST para obter modelos .gitignore do repositório .gitignore do GitHub.

Você pode usar o tipo de mídia personalizado application/vnd.github.raw ao obter um modelo gitignore. Para obter mais informações, confira "Tipos de mídia".

Get all gitignore templates

Funciona com GitHub Apps

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

Códigos de status de resposta HTTP para "Get all gitignore templates"

Código de status	Descrição
`200`	OK
`304`	Not modified

Exemplos de código para "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

Funciona com GitHub Apps

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

Parâmetros para "Get a gitignore template"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`name` string Obrigatório

Códigos de status de resposta HTTP para "Get a gitignore template"

Código de status	Descrição
`200`	OK
`304`	Not modified

Exemplos de código para "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"
}