Skip to main content

Gitignore

La API de Gitignore recupera las plantillas de .gitignore que pueden usarse para ignorar archivos y directorios.

Acerca de Gitignore API

Al crear un repositorio en GitHub AE mediante la API, puedes especificar una plantilla de .gitignore para aplicarla al repositorio cuando se cree. La API de plantillas de .gitignore enumera y recupera plantillas del repositorio .gitignore de GitHub AE.

Tipos de medios personalizados para gitignore

Puedes utilizar este tipo de medios personalizado cuando obtengas una plantilla de gitignore.

application/vnd.github.raw

Para más información, vea "Tipos de soporte físico".

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