REST-API-Endpunkte für gitignore

Verwende die REST-API, um Vorlagen vom Typ .gitignore abzurufen, die zum Ignorieren von Dateien und Verzeichnissen verwendet werden können.

Informationen zu gitignore

Wenn Sie ein neues Repository in GitHub über die API erstellen, können Sie eine GITIGNORE-Vorlage festlegen, die beim Erstellen auf das Repository angewendet werden soll. Du kannst die REST-API zum Abrufen von GITIGNORE-Vorlagen aus dem .gitignore-Repository auf GitHub verwenden.

Get all gitignore templates

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

Differenzierte Zugriffstoken für "Get all gitignore templates"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für „Get all gitignore templates“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Get all gitignore templates“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Get a gitignore template"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get a gitignore template“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich

HTTP-Antwortstatuscodes für „Get a gitignore template“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Get a gitignore template“

Anforderungsbeispiel

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