Gitignore - Documentation GitHub

Utilisez l’API REST pour obtenir des modèles .gitignore qui peuvent être utilisés pour ignorer les fichiers et les répertoires.

À propos de gitignore

Quand vous créez un référentiel sur GitHub.com via l’API, vous pouvez spécifier un modèle .gitignore à appliquer au référentiel lors de la création. Vous pouvez utiliser l’API REST pour obtenir les modèles .gitignore du dépôt .gitignore GitHub.

Vous pouvez utiliser le type de média personnalisé application/vnd.github.raw lors de l’obtention d’un modèle gitignore. Pour plus d’informations, consultez « Types de médias ».

Get all gitignore templates

Compatible avec GitHub Apps

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

Codes d’état de la réponse HTTP pour « Get all gitignore templates »

Code d’état	Description
`200`	OK
`304`	Not modified

Exemples de code pour « 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

Compatible avec GitHub Apps

The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.

Paramètres pour « Get a gitignore template »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
Paramètres de chemin d’accès
Nom, Type, Description
`name` string Obligatoire

Codes d’état de la réponse HTTP pour « Get a gitignore template »

Code d’état	Description
`200`	OK
`304`	Not modified

Exemples de code pour « 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"
}