设计时 API 分组管理（ApiGroupDesignTimeController）

API 中心 .apigroup 资源的设计时管理：列表查询、详情获取、新建、更新与批量删除。API 分组（ApiGroup）用于聚合一组相关的 API 配置，直接挂在应用下。

• 接口类型：REST 资源
• 基址：${myapps.context-path.designer:}/api/designtime/applications（类级 @RequestMapping，produces = APPLICATION_JSON_VALUE）
• Tag：API分组操作模块

公共说明

• 鉴权：是（需 designerToken）。控制器继承自 AbstractDesignTimeController（基类为 @RestController），通过 Security.getDesignerIdFromToken(request) 从 designerToken JWT 中解析设计器用户。鉴权机制详见 index.md「鉴权说明」。
• 路径变量：{applicationId}、{apiGroupId} 均为**明文设计时 ID**。
• 响应：统一 Resource（见 ../index.md「统一响应结构」）。成功 errcode=0；保存时抛 OBPMValidateException（名称重复）返回 errcode=40001；其他异常 errcode=500。
• HTTP 方法：受 CommonSecurityFilter 限制，仅允许 GET/POST/HEAD/OPTIONS。
• 请求体约定：POST/PUT 接收原始 JSON 字符串（@RequestBody String content），由服务端用 JSONObject.fromObject 解析后通过 json2obj 转 ApiGroup；DELETE 接收原始 JSON 字符串（@RequestBody String content），由 com.jayway.jsonpath.JsonPath.parse(content).json() 反序列化为 List<String>（与多数控制器接收 String[] 不同）。
• 隶属关系：新建时 applicationid 与 parentId 均固定设为 applicationId（API 分组直接挂在应用下）。

---

1. 获取 API 分组列表

分页获取指定应用下的 API 分组列表，可按名称查询。

• 接口类型：REST 资源
• 请求方式：GET
• 请求路径：/{applicationId}/apigroups（完整：{designer-context}/api/designtime/applications/{applicationId}/apigroups）
• 鉴权：是（需 designerToken）
• Tag：API分组操作模块

请求参数

参数名	位置	类型	必填	说明
applicationId	path	string	是	应用Id
name	query	string	否	按名称查询关键字
pageNo	query	int	否	页码（缺省 1）
linesPerPage	query	int	否	每页条数（缺省 10）

说明：name/pageNo/linesPerPage 均标注 @RequestParam(required = false)，故均可缺省；pageNo/linesPerPage 提供 defaultValue。

请求示例

GET /api/designtime/applications/{applicationId}/apigroups?name=&pageNo=1&linesPerPage=10 HTTP/1.1

响应

结构：统一 Resource（见 ../index.md「统一响应结构」）。 data：DataPackage<ApiGroup>（含分页字段与 datas）。

成功示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageNo": 1,
    "pageCount": 1,
    "rowCount": 1,
    "datas": [
      { "id": "...", "name": "分组名称", "...": "..." }
    ]
  },
  "errors": null
}

失败示例：

{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }

---

2. 获取 API 分组详情

按 API 分组Id获取完整 API 分组对象。

• 接口类型：REST 资源
• 请求方式：GET
• 请求路径：/{applicationId}/apigroups/{apiGroupId}
• 鉴权：是（需 designerToken）
• Tag：API分组操作模块

请求参数

参数名	位置	类型	必填	说明
applicationId	path	string	是	应用Id
apiGroupId	path	string	是	API 分组主键Id

响应

data：ApiGroup 完整对象。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "...", "name": "...", "...": "..." }, "errors": null }

失败示例：

{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }

---

3. 新建 API 分组

在指定应用下新建 API 分组。请求体解析为 ApiGroup 后强制覆盖 applicationid 与 parentId（均设为 applicationId），保存前做名称重名校验。HTTP 状态码 201。

• 接口类型：REST 资源
• 请求方式：POST
• 请求路径：/{applicationId}/apigroups
• 鉴权：是（需 designerToken）
• Tag：API分组操作模块

请求参数

参数名	位置	类型	必填	说明
applicationId	path	string	是	应用Id
content	body	string(JSON)	是	API 分组对象 JSON

请求体

对应 ApiGroup 对象 JSON（name 等）。

{ "name": "<分组名>" }

响应

data：JSONObject，仅含 id（新建分组Id）。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "<分组Id>" }, "errors": null }

失败示例（重名）：

{ "errcode": 40001, "errmsg": "名称已经存在！", "data": null, "errors": null }

失败示例（其他异常）：

{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }

---

4. 更新 API 分组

按 API 分组Id更新分组对象。先按 apiGroupId 查出原对象并克隆，再用请求体中的 name 覆盖（其余字段保留原值），强制清空 uri 后保存。HTTP 状态码 201（源码 @ResponseStatus(HttpStatus.CREATED)，更新场景亦返回 201）。

• 接口类型：REST 资源
• 请求方式：PUT
• 请求路径：/{applicationId}/apigroups/{apiGroupId}
• 鉴权：是（需 designerToken）
• Tag：API分组操作模块

请求参数

参数名	位置	类型	必填	说明
applicationId	path	string	是	应用Id
apiGroupId	path	string	是	API 分组Id（用于查找原对象）
content	body	string(JSON)	是	API 分组对象 JSON（取 name）

请求体

对应 ApiGroup 对象 JSON（仅 name 会被采用）。

{ "name": "<分组名>" }

响应

data：null（成功）。

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }

失败示例（重名）：

{ "errcode": 40001, "errmsg": "名称已经存在！", "data": null, "errors": null }

失败示例（其他异常）：

{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }

---

5. 删除 API 分组（可批量）

按 API 分组Id数组批量删除分组（删除前收集各分组的路径信息）。请求体为 JSON 字符串（由 JsonPath 反序列化为 List<String>）。

注：源码 @Operation(summary) 文案误写为「删除api」，实际为删除 API 分组。

• 接口类型：REST 资源
• 请求方式：DELETE
• 请求路径：/{applicationId}/apigroups
• 鉴权：是（需 designerToken）
• Tag：API分组操作模块

请求参数

参数名	位置	类型	必填	说明
applicationId	path	string	是	应用Id
content	body	string(JSON)	是	API 分组Id字符串数组（JSON 数组形式）

请求体

["<apiGroupId1>", "<apiGroupId2>"]

响应

data：String，固定为 "删除成功"。

{ "errcode": 0, "errmsg": "ok", "data": "删除成功", "errors": null }

失败示例：

{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }

---