Gitignore

Usa la API de REST para obtener plantillas de .gitignore que se pueden usar para omitir archivos y directorios.

Acerca de gitignore

Al crear un repositorio en GitHub.com mediante la API, puedes especificar una plantilla de .gitignore para aplicarla al repositorio cuando se cree. Puedes usar la API de REST para obtener plantillas de .gitignore del repositorio .gitignore de GitHub Enterprise Cloud.

Puedes utilizar el tipo de medios personalizado application/vnd.github.raw cuando obtengas una plantilla de gitignore. Para obtener más información, vea «Tipos de medios».

Get all gitignore templates

Funciona con GitHub Apps

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

Códigos de estado de respuesta HTTP para "Get all gitignore templates"

status code	Descripción
`200`	OK
`304`	Not modified

Ejemplos 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 con 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"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.
Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`name` string Requerido

Códigos de estado de respuesta HTTP para "Get a gitignore template"

status code	Descripción
`200`	OK
`304`	Not modified

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