跳转至

设计时链接管理(LinkController)

链接资源的设计时管理:链接的列表查询、详情获取、新建、更新与批量删除;用于在应用中配置跳转链接。

  • 接口类型:REST 资源
  • 基址${myapps.context-path.designer:}/api/designtime/applications(类级 @RequestMappingproduces = APPLICATION_JSON_VALUE
  • Tag:设计时-链接模块

公共说明

  • 鉴权:是(需 designerToken)。控制器继承自 AbstractDesignTimeController(基类为 @RestController),通过 Security.getDesignerIdFromToken(request) 从 designerToken JWT 中解析设计器用户。鉴权机制详见 index.md「鉴权说明」。
  • 路径变量{applicationId}{linkId} 均为**明文设计时 ID**。
  • 响应:统一 Resource(见 ../index.md「统一响应结构」)。成功 errcode=0;异常默认 errcode=500;新建时名称为空返回 errmsg="{*[cn.myapps.kms.category.name_not_null]*}"、重名返回 errmsg="{*[core.form.exist]*}",均为 errcode=500(包在统一 Resource 中)。
  • HTTP 方法:受 CommonSecurityFilter 限制,仅允许 GET/POST/HEAD/OPTIONS
  • 请求体约定:POST/PUT 接收原始 JSON 字符串(@RequestBody String content),由服务端用 JSONObject.fromObject 解析后 json2objLinkVO;DELETE 接收 JSON 字符串数组(@RequestBody String[])。
  • 隶属关系:新建时 parentId 固定设为 applicationId(链接直接挂在应用下,无模块层)。

1. 获取链接列表

分页获取指定应用下的链接列表,可按名称关键字与类型过滤。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/{applicationId}/links(完整:{designer-context}/api/designtime/applications/{applicationId}/links
  • 鉴权:是(需 designerToken)
  • Tag:设计时-链接模块

请求参数

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

说明:name/type/pageNo/linesPerPage 形参未标注 @RequestParam,由 Spring MVC 按请求参数绑定,故均可缺省。

请求示例

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

响应

结构:统一 Resource(见 ../index.md「统一响应结构」)。 dataDataPackage<LinkVO>(含分页字段与 datas)。

成功示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageNo": 1,
    "pageCount": 1,
    "rowCount": 1,
    "datas": [
      { "id": "...", "name": "链接名称", "type": "...", "...": "..." }
    ]
  },
  "errors": null
}
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


2. 获取链接详情

按链接Id获取完整链接对象。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/{applicationId}/links/{linkId}
  • 鉴权:是(需 designerToken)
  • Tag:设计时-链接模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
linkId path string 链接Id

响应

dataLinkVO 完整对象。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "...", "name": "...", "type": "...", "...": "..." }, "errors": null }
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


3. 新建链接

在指定应用下新建链接。请求体解析为 LinkVO 后强制覆盖 applicationid/parentId(均设为 applicationId),id 为空时生成新的设计时序列号;保存前做名称非空与重名校验。

  • 接口类型:REST 资源
  • 请求方式POST
  • 请求路径/{applicationId}/links
  • 鉴权:是(需 designerToken)
  • Tag:设计时-链接模块

请求参数

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

请求体

对应 LinkVO 对象 JSON(nametype、目标地址等)。

{ "name": "<链接名>", "type": "...", "...": "..." }

响应

dataJSONObject,仅含 id(新建链接Id)。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "<链接Id>" }, "errors": null }
失败示例(名称为空):
{ "errcode": 500, "errmsg": "{*[cn.myapps.kms.category.name_not_null]*}", "data": null, "errors": null }
失败示例(重名):
{ "errcode": 500, "errmsg": "{*[core.form.exist]*}", "data": null, "errors": null }


4. 更新链接

按链接Id更新链接对象。请求体解析后强制覆盖 applicationidid(取路径 linkId),随后 saveOrUpdate

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/links/{linkId}
  • 鉴权:是(需 designerToken)
  • Tag:设计时-链接模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
linkId path string 链接Id(覆盖请求体中的 id)
content body string(JSON) 链接对象 JSON

请求体

对应 LinkVO 对象 JSON。

{ "name": "<链接名>", "...": "..." }

响应

datanull(成功)。

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


5. 删除链接(可批量)

按链接Id数组批量删除链接(含路径信息收集)。

  • 接口类型:REST 资源
  • 请求方式DELETE
  • 请求路径/{applicationId}/links
  • 鉴权:是(需 designerToken)
  • Tag:设计时-链接模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
ids body string 链接Id字符串数组

请求体

["<linkId1>", "<linkId2>"]

响应

dataString,固定为 "删除成功"

{ "errcode": 0, "errmsg": "ok", "data": "删除成功", "errors": null }
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }