352.md

# Project templates API

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

*   [Get all templates of a particular type](#get-all-templates-of-a-particular-type)
*   [Get one template of a particular type](#get-one-template-of-a-particular-type)

# Project templates API[](#project-templates-api "Permalink")

此 API 是这些端点的特定于项目的版本：

*   [Dockerfile templates](templates/dockerfiles.html)
*   [Gitignore templates](templates/gitignores.html)
*   [GitLab CI/CD Configuration templates](templates/gitlab_ci_ymls.html)
*   [Open source license templates](templates/licenses.html)

它不赞成使用这些端点，对​​于 API 版本 5 将会删除这些端点.

除了整个实例通用的模板之外，该 API 端点还提供特定于项目的模板.

在以后的[版本中，](../user/project/description_templates.html)将添加对[发布和合并请求模板的](../user/project/description_templates.html)支持.

支持[组级文件模板](../user/group/index.html#group-file-templates-premium) 是在 GitLab 11.5 中[添加的](https://gitlab.com/gitlab-org/gitlab/-/issues/5987)

## Get all templates of a particular type[](#get-all-templates-of-a-particular-type "Permalink")

```
GET /projects/:id/templates/:type 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | 整数/字符串 | yes | 项目的 ID 或[URL 编码的路径](README.html#namespaced-path-encoding) |
| `type` | string | yes | 模板的类型`(dockerfiles|gitignores|gitlab_ci_ymls|licenses)` |

响应示例（许可证）：

```
[  {  "key":  "epl-1.0",  "name":  "Eclipse Public License 1.0"  },  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0"  },  {  "key":  "unlicense",  "name":  "The Unlicense"  },  {  "key":  "agpl-3.0",  "name":  "GNU Affero General Public License v3.0"  },  {  "key":  "gpl-3.0",  "name":  "GNU General Public License v3.0"  },  {  "key":  "bsd-3-clause",  "name":  "BSD 3-clause \"New\" or \"Revised\" License"  },  {  "key":  "lgpl-2.1",  "name":  "GNU Lesser General Public License v2.1"  },  {  "key":  "mit",  "name":  "MIT License"  },  {  "key":  "apache-2.0",  "name":  "Apache License 2.0"  },  {  "key":  "bsd-2-clause",  "name":  "BSD 2-clause \"Simplified\" License"  },  {  "key":  "mpl-2.0",  "name":  "Mozilla Public License 2.0"  },  {  "key":  "gpl-2.0",  "name":  "GNU General Public License v2.0"  }  ] 
```

## Get one template of a particular type[](#get-one-template-of-a-particular-type "Permalink")

```
GET /projects/:id/templates/:type/:key 
```

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | 整数/字符串 | yes | 项目的 ID 或[URL 编码的路径](README.html#namespaced-path-encoding) |
| `type` | string | yes | 模板的类型`(dockerfiles|gitignores|gitlab_ci_ymls|licenses)` |
| `key` | string | yes | 从集合端点获取的模板的密钥 |
| `project` | string | no | 在模板中扩展占位符时要使用的项目名称. 仅影响许可证 |
| `fullname` | string | no | 在模板中扩展占位符时使用的版权所有者的全名. 仅影响许可证 |

响应示例（Dockerfile）：

```
{  "name":  "Binary",  "content":  "# This file is a template, and might need editing before it works on your project.\n# This Dockerfile installs a compiled binary into a bare system.\n# You must either commit your compiled binary into source control (not recommended)\n# or build the binary first as part of a CI/CD pipeline.\n\nFROM buildpack-deps:jessie\n\nWORKDIR /usr/local/bin\n\n# Change `app` to whatever your binary is called\nAdd app .\nCMD [\"./app\"]\n"  } 
```

响应示例（许可证）：

```
{  "key":  "mit",  "name":  "MIT License",  "nickname":  null,  "popular":  true,  "html_url":  "http://choosealicense.com/licenses/mit/",  "source_url":  "https://opensource.org/licenses/MIT",  "description":  "A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.",  "conditions":  [  "include-copyright"  ],  "permissions":  [  "commercial-use",  "modifications",  "distribution",  "private-use"  ],  "limitations":  [  "liability",  "warranty"  ],  "content":  "MIT License\n\nCopyright (c) 2018 [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"  } 
```