Skip to main content

Gitignore

A API do Gitignore busca modelos .gitignore que podem ser usados para ignorar arquivos e diretórios.

Sobre a API do Gitignore

Ao criar um novo repositório em GitHub.com por meio da API, você pode especificar um .gitignore template para que seja aplicado ao repositório após a criação. A API de modlos do .gitignore lista e recupera modelos do repositório de .gitignore de GitHub Enterprise Cloud.

Tipos de mídia personalizados para gitignore

Você pode usar este tipo de mídia personalizada ao obter um modelo de gitignore.

application/vnd.github.VERSION.raw

Para obter mais informações, consulte "Tipos de mídia".

Get all gitignore templates

Works with GitHub Apps

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

HTTP response status codes

Status codeDescrição
200

OK

304

Not modified

Amostras de código

get/gitignore/templates
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/gitignore/templates

Response

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

Get a gitignore template

Works with 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

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
namestringObrigatório

HTTP response status codes

Status codeDescrição
200

OK

304

Not modified

Amostras de código

get/gitignore/templates/{name}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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" }