Puntos de conexión de la API de REST para 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 mediante la API, puede 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.

Get all gitignore templates

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

Tokens de acceso específicos para "Get all gitignore templates"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

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"

Ejemplo de solicitud

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 acceso específicos para "Get a gitignore template"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

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"

Ejemplo de solicitud

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