Skip to main content

Gitignore

A API do Gitignore busca modelos .gitignore que podem ser usados para ignorar arquivos e diretórios.

When you create a new repository on GitHub AE via the API, you can specify a .gitignore template to apply to the repository upon creation. A API de modlos do .gitignore lista e recupera modelos do repositório de .gitignore de GitHub AE.

Tipos de mídia personalizados para gitignore

Você pode usar este tipo de mídia personalizada ao obter um modelo de gitignore.

application/vnd.github.VERSION.raw

Para obter mais informações, consulte "Tipos de mídia".

Get all gitignore templates

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

get /gitignore/templates

Amostras de código

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/api/v3/gitignore/templates
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates')

Response

Status: 200 OK
[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

Not modified

Status: 304 Not Modified

Notes

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.

get /gitignore/templates/{name}

Parâmetros

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended.

name string path

Amostras de código

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/api/v3/gitignore/templates/NAME
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates/{name}', {
  name: 'name'
})

Response

Status: 200 OK
{
  "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"
}

Not modified

Status: 304 Not Modified

Notes