设计时样式库管理(StylesController)¶
样式库(StyleRepositoryVO)的设计时管理:样式库的列表查询、详情获取、新建、更新与批量删除;用于集中维护应用级样式源码。
- 接口类型:REST 资源
- 基址:
${myapps.context-path.designer:}/api/designtime/applications(类级@RequestMapping,produces = APPLICATION_JSON_VALUE) - Tag:设计时-样式库模块
公共说明¶
- 鉴权:是(需 designerToken)。控制器继承自
AbstractDesignTimeController(基类为@RestController),通过Security.getDesignerIdFromToken(request)从 designerToken JWT 中解析设计器用户。鉴权机制详见 index.md「鉴权说明」。 - 路径变量:
{applicationId}、{styleId}均为**明文设计时 ID**。 - 响应:统一
Resource(见 ../index.md「统一响应结构」)。成功errcode=0;异常默认errcode=500;保存校验失败(库名称重复)捕获OBPMValidateException,返回errcode=40001,errmsg形如" 库名称重复 ,请重新命名再保存! "。 - HTTP 方法:受
CommonSecurityFilter限制,仅允许GET/POST/HEAD/OPTIONS。 - 请求体约定:POST/PUT 接收原始 JSON 字符串(
@RequestBody String content),由服务端用JSONObject.fromObject解析后json2obj转StyleRepositoryVO;DELETE 接收 JSON 字符串数组(@RequestBody String[])。 - 隶属关系:新建时
parentId固定设为applicationId。 - 更新语义:更新时先按
styleId查询旧对象并克隆(BeanUtils.cloneBean),仅应用请求体的content/name/description并清空uri,再校验后saveOrUpdate。
1. 获取样式库列表¶
分页获取指定应用下的样式库列表,可按名称关键字查询。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/{applicationId}/styles(完整:{designer-context}/api/designtime/applications/{applicationId}/styles) - 鉴权:是(需 designerToken)
- Tag:设计时-样式库模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id |
| name | query | string | 否 | 按样式库名称查询关键字 |
| pageNo | query | string | 否 | 页码(缺省 1) |
| linesPerPage | query | string | 否 | 每页条数(缺省 10) |
说明:
name/pageNo/linesPerPage形参未标注@RequestParam,由 Spring MVC 按请求参数绑定,故均可缺省。
请求示例¶
响应¶
结构:统一 Resource(见 ../index.md「统一响应结构」)。
data:DataPackage<StyleRepositoryVO>(含分页字段与 datas)。
成功示例:
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageNo": 1,
"pageCount": 1,
"rowCount": 1,
"datas": [
{ "id": "...", "name": "样式库名", "description": "...", "content": "<样式源码>", "...": "..." }
]
},
"errors": null
}
2. 获取样式库详情¶
按样式库Id获取完整样式库对象。
- 接口类型:REST 资源
- 请求方式:
GET - 请求路径:
/{applicationId}/styles/{styleId} - 鉴权:是(需 designerToken)
- Tag:设计时-样式库模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id |
| styleId | path | string | 是 | 样式库Id |
响应¶
data:StyleRepositoryVO 完整对象。
{ "errcode": 0, "errmsg": "ok", "data": { "id": "...", "name": "...", "content": "<样式源码>", "description": "...", "...": "..." }, "errors": null }
3. 新建样式库¶
在指定应用下新建样式库。请求体解析为 StyleRepositoryVO 后强制覆盖 applicationid/parentId(均设为 applicationId),id 为空时生成新的设计时序列号;保存前调用 doSaveValidate 校验库名称不重复。HTTP 状态码 201。
- 接口类型:REST 资源
- 请求方式:
POST - 请求路径:
/{applicationId}/styles - 鉴权:是(需 designerToken)
- Tag:设计时-样式库模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id |
| content | body | string(JSON) | 是 | 样式库对象 JSON |
请求体¶
对应 StyleRepositoryVO 对象 JSON(name、content、description 等)。
响应¶
data:JSONObject,仅含 id(新建样式库Id)。
4. 更新样式库¶
按样式库Id更新样式库。先按 styleId 查询旧对象并克隆,仅应用请求体的 content/name/description 并清空 uri,校验名称不重复后 saveOrUpdate。
- 接口类型:REST 资源
- 请求方式:
PUT - 请求路径:
/{applicationId}/styles/{styleId} - 鉴权:是(需 designerToken)
- Tag:设计时-样式库模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id |
| styleId | path | string | 是 | 样式库Id |
| content | body | string(JSON) | 是 | 样式库对象 JSON(仅取 content/name/description) |
请求体¶
响应¶
data:null(成功)。
5. 删除样式库(可批量)¶
按样式库Id数组批量删除样式库(含路径信息收集)。
- 接口类型:REST 资源
- 请求方式:
DELETE - 请求路径:
/{applicationId}/styles - 鉴权:是(需 designerToken)
- Tag:设计时-样式库模块
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| applicationId | path | string | 是 | 应用Id |
| ids | body | string | 是 | 样式库Id字符串数组 |
请求体¶
响应¶
data:String,固定为 "删除成功"。