Points de terminaison d’API REST pour gitignore
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 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 Enterprise Server.
Get all gitignore templates
List all templates available to pass as an option when creating a repository.
Jetons d’accès affinés pour « Get all gitignore templates »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis ne nécessite aucune autorisation.
Ce point de terminaison peut être utilisé sans authentification ou si seules les ressources publiques sont demandées.
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 »
Exemple de requête
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/gitignore/templatesResponse
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.
Jetons d’accès affinés pour « Get a gitignore template »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis ne nécessite aucune autorisation.
Ce point de terminaison peut être utilisé sans authentification ou si seules les ressources publiques sont demandées.
Paramètres pour « Get a gitignore template »
| Nom, Type, Description |
|---|
accept string Setting to |
| 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 »
Exemple de requête
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/gitignore/templates/NAMEResponse
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"
}