文档首页> DevStar> API参考> API> 代码生成> CodeArts Repo模板生成代码
更新时间:2023-03-01 GMT+08:00
分享

CodeArts Repo模板生成代码

功能介绍

使用CodeArts Repo模板创建应用代码。

通过CodeArts Repo模板创建生成应用代码的任务,并将应用代码存储于指定的CodeArts Repo仓库中或者生成代码压缩包,可以通过返回的任务 ID 查询相关任务状态。

  • 接口鉴权方式 通过华为云服务获取的用户token。
  • 代码生成位置 应用代码生成后的地址,目前支持CodeArts Repo地址和压缩包下载地址。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/jobs/codehub

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

X-Language

String

语言类型,缺省值为“zh-cn”。

枚举值:

  • zh-cn:中文
  • en-us:英文
表2 请求Body参数

参数

是否必选

参数类型

描述

application_name

String

应用名称。

privately

Boolean

仓库是否私有

short_id

String

仓库短id

code_url

String

代码存放的ssh地址。

region_id

String

CodeArts Repo仓库所在的 Region ID:

  • 华南-广州:cn-south-1
  • 华东-上海二:cn-east-2
  • 华北-北京一:cn-north-1
  • 华北-北京四:cn-north-4

repo_type

Integer

  • 0 - 将生成的应用代码存储于 repo_info 指定的CodeArts Repo仓库中。
  • 1 - 将生成的应用代码存储到华为云,任务创建人可以通过 ExportApplicationCode 下载代码压缩包。

properties

Map<String,String>

可以根据 template-metadata.json 获取动态参数 ID 以及规则。

repo_info

RepositoryInfo object

生成的代码框架存储的CodeArts Repo信息, 当 repo_type = 0 时必填。

表3 RepositoryInfo

参数

是否必选

参数类型

描述

name

String

代码仓的名称。

description

String

代码仓描述。

project_id

String

项目id。

region_id

String

区域id。

gitignore

String

根据编程语言生成gitignore文件。

member_permission

Integer

是否允许项目内成员访问仓库:

  • 0:不允许
  • 1:允许

readme_permission

Integer

是否允许生成README文件:

  • 0:不允许
  • 1:允许

visibility_level

Integer

是否公开:

  • 0:私有
  • 20:公开只读

license_id

Integer

开源许可证id (0:默认)。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务id。

file_list

Array of FileTreeNode objects

文件列表。

表5 FileTreeNode

参数

参数类型

描述

file_path

String

文件路径

file_name

String

文件名称

file_type

String

是否文件夹

请求示例

请求样例

{
  "region_id" : "cn-north-7",
  "code_url" : "git@codehub.alpha.devcloud.inhuawei.com:nizhiwei00001/nizhiwei001.git",
  "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

错误码

请参见错误码

分享:

    相关文档

    相关产品