使用 Devstar 模板创建代码生成任务并下载代码工程到本地

概述

本文通过调用一系列模板服务的 API 介绍使用 Devstar 模板创建应用代码并下载到本地的基本流程。

其中，模板使用Devstar官方SpringBoot模板。

API 的调用方法请参见如何调用API。

创建流程

1. 调用接口查询模板列表查询模板列表。
2. 调用接口查询模板详情（V3）查询模板 UUID。
3. 调用接口Devstar 模板生成代码创建代码生成任务。
4. 调用接口查询任务详情查询任务详情。
5. 调用接口下载代码工程下载代码到本地。

创建生成代码任务

1. 调用接口查询模板列表查询模板列表,获取 template_id。

   POST /v1/templates/query
   {
    "keyword": "SpringBoot",
    "offset": 0,
    "limit": 10
   }

   您需要指定如下参数：

   • keyword：进行模糊搜索模板的名称参数，这里使用的是SpringBoot。
   • offset：模糊搜索的索引偏移量。
   • limit：该次请求最多返回的符合条件的模板条数。

2. 使用步骤1获取的 template_id，调用接口查询模板详情（V3）查询模板信息。

   GET /v3/templates/{template_id}

   template_id由步骤1获取。

3. 使用步骤2获取的模板信息，调用接口Devstar 模板生成代码创建代码生成任务。

   POST /v1/jobs/template
   {
       "application_name": "string",
       "properties": "object",
       "repo_type": "1",
       "template_id": "string"
   }

   您需要指定如下参数：

   • application_name：自定义应用名称。
   • repo_type：该场景值为1。
   • code_url：用户模板仓库的 ssh 地址，查询方法参见获取仓库信息。
   • properties：与生成代码相关的参数列表，根据步骤2的返回结果填写。

4. 使用步骤3获取的任务 id ，调用接口查询任务详情查询任务详情。

   GET /v1/jobs/{job_id}

   job_id由步骤3获取。

5. 使用步骤3获取的任务 id ，调用接口下载代码工程下载应用代码压缩包。

   GET /template/v1/application-codes?job_id={job_id}

   job_id由步骤3获取。

   任务执行完毕，所有步骤都执行成功后，您可以在 本地查看到生成的应用代码。