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 du ein neues Repository in GitHub.com über die API erstellst, kannst du 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 Enterprise Cloud verwenden.
Du kannst den benutzerdefinierten Medientyp application/vnd.github.raw
beim Abrufen einer GITIGNORE-Vorlage verwenden. Weitere Informationen findest du unter Medientypen.
Get all gitignore templates
List all templates available to pass as an option when creating a repository.
HTTP-Antwortstatuscodes für „Get all gitignore templates“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
304 | Not modified |
Codebeispiele für „Get all 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
The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.
Parameter für „Get a gitignore template“
Header |
---|
Name, type, BESCHREIBUNG |
accept string Setting to |
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“
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"
}