Skip to main content

Gitignore

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

Sobre a API do Gitignore

Quando você cria um repositório no GitHub AE por meio da API, você pode especificar um modelo .gitignore para aplicá-lo ao repositório após a criação. A API de modelos .gitignore lista modelos do repositório .gitignore do GitHub AE e efetua fetch deles.

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.raw

Para obter mais informações, confira "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 codeDescription
200

OK

304

Not modified

Code samples

get/gitignore/templates
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/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.

Parameters

Headers
Name, Type, Description
acceptstring

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

Path parameters
Name, Type, Description
namestringRequired

HTTP response status codes

Status codeDescription
200

OK

304

Not modified

Code samples

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