Pontos de extremidade da API REST para 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 novo repositório no GitHub 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 Enterprise Cloud.

Get all gitignore templates

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

Tokens de acesso refinados para "Get all gitignore templates"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinaado não requer permissões.

Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.

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"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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.

Tokens de acesso refinados para "Get a gitignore template"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinaado não requer permissões.

Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.

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"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

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