286.md

# `.gitignore` API

> 原文：[https://docs.gitlab.com/ee/api/templates/gitignores.html](https://docs.gitlab.com/ee/api/templates/gitignores.html)

*   [List `.gitignore` templates](#list-gitignore-templates)
*   [Single `.gitignore` template](#single-gitignore-template)

# `.gitignore` API[](#gitignore-api "Permalink")

在 GitLab 中，有一个`.gitignore`可用的 API 端点. 有关`gitignore`更多信息，请参见[Git 文档](https://git-scm.com/docs/gitignore) .

## List `.gitignore` templates[](#list-gitignore-templates "Permalink")

获取所有`.gitignore`模板.

```
GET /templates/gitignores 
```

请求示例：

```
curl https://gitlab.example.com/api/v4/templates/gitignores 
```

响应示例：

```
[  {  "key":  "Actionscript",  "name":  "Actionscript"  },  {  "key":  "Ada",  "name":  "Ada"  },  {  "key":  "Agda",  "name":  "Agda"  },  {  "key":  "Android",  "name":  "Android"  },  {  "key":  "AppEngine",  "name":  "AppEngine"  },  {  "key":  "AppceleratorTitanium",  "name":  "AppceleratorTitanium"  },  {  "key":  "ArchLinuxPackages",  "name":  "ArchLinuxPackages"  },  {  "key":  "Autotools",  "name":  "Autotools"  },  {  "key":  "C",  "name":  "C"  },  {  "key":  "C++",  "name":  "C++"  },  {  "key":  "CFWheels",  "name":  "CFWheels"  },  {  "key":  "CMake",  "name":  "CMake"  },  {  "key":  "CUDA",  "name":  "CUDA"  },  {  "key":  "CakePHP",  "name":  "CakePHP"  },  {  "key":  "ChefCookbook",  "name":  "ChefCookbook"  },  {  "key":  "Clojure",  "name":  "Clojure"  },  {  "key":  "CodeIgniter",  "name":  "CodeIgniter"  },  {  "key":  "CommonLisp",  "name":  "CommonLisp"  },  {  "key":  "Composer",  "name":  "Composer"  },  {  "key":  "Concrete5",  "name":  "Concrete5"  }  ] 
```

## Single `.gitignore` template[](#single-gitignore-template "Permalink")

获取单个`.gitignore`模板.

```
GET /templates/gitignores/:key 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | string | yes | `.gitignore`模板的键 |

请求示例：

```
curl https://gitlab.example.com/api/v4/templates/gitignores/Ruby 
```

响应示例：

```
{  "name":  "Ruby",  "content":  "*.gem\n*.rbc\n/.config\n/coverage/\n/InstalledFiles\n/pkg/\n/spec/reports/\n/spec/examples.txt\n/test/tmp/\n/test/version_tmp/\n/tmp/\n\n# Used by dotenv library to load environment variables.\n# .env\n\n## Specific to RubyMotion:\n.dat*\n.repl_history\nbuild/\n*.bridgesupport\nbuild-iPhoneOS/\nbuild-iPhoneSimulator/\n\n## Specific to RubyMotion (use of CocoaPods):\n#\n# We recommend against adding the Pods directory to your .gitignore. However\n# you should judge for yourself, the pros and cons are mentioned at:\n# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control\n#\n# vendor/Pods/\n\n## Documentation cache and generated files:\n/.yardoc/\n/_yardoc/\n/doc/\n/rdoc/\n\n## Environment normalization:\n/.bundle/\n/vendor/bundle\n/lib/bundler/man/\n\n# for a library or gem, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# Gemfile.lock\n# .ruby-version\n# .ruby-gemset\n\n# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:\n.rvmrc\n"  } 
```