Devstar 模板生成代码
功能介绍
使用DevStar的模板创建应用代码。
通过 DevStar 模板创建生成应用代码的任务，并将应用代码存储于指定的CodeArts Repo仓库中，可以通过返回的任务 ID 查询相关任务状态。
- 接口鉴权方式 通过华为云服务获取的用户token。
- 代码生成位置 应用代码生成后的地址，目前支持CodeArts Repo地址和压缩包下载地址。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/jobs/template
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
| X-Language | 否 | String | 语言类型，缺省值为“zh-cn”。 枚举值：
|
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| application_name | 否 | String | 应用名称 |
| template_id | 是 | String | 任务依赖的模板id |
| project_name | 否 | String | 应用名称 |
| repo_type | 否 | Integer | 应用代码生成后的地址类型，目前支持0：CodeArts Repo地址和1：压缩包下载地址 |
| properties | 否 | Object | 应用的动态参数json |
| template_dependencies | 否 | Array of strings | 模板 dependency ID 集合 |
| repo_info | 否 | RepositoryInfo object | 仓库信息 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 代码仓的名称。 |
| description | 否 | String | 代码仓描述。 |
| project_id | 否 | String | 项目id。 |
| region_id | 否 | String | 区域id。 |
| gitignore | 否 | String | 根据编程语言生成gitignore文件。 |
| member_permission | 否 | Integer | 是否允许项目内成员访问仓库：
|
| readme_permission | 否 | Integer | 是否允许生成README文件：
|
| visibility_level | 否 | Integer | 是否公开：
|
| license_id | 否 | Integer | 开源许可证id （0:默认）。 |
响应参数
状态码： 202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 任务id。 |
| file_list | Array of FileTreeNode objects | 文件列表。 |
请求示例
请求样例
{
"template_id" : "ad124ea592544244a73eb33f3ce9aedc",
"application_name" : "codeArts_repo_app",
"repo_type" : 1,
"properties" : {
"artifactId" : "Hello"
}
} 响应示例
状态码： 202
Accepted
{
"id" : "j_zNvQCYTy"
} 状态码： 400
Bad Request
{
"error_code" : "HDN.1001",
"error_msg" : "参数错误"
} 状态码： 401
Unauthorized
{
"error_code" : "HDN.1001",
"error_msg" : "权限错误"
} 状态码： 403
Forbidden
{
"error_code" : "HDN.1001",
"error_msg" : "权限错误"
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | Accepted |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。
