新增模块
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/01-新增模块.md
详细说明
用于新增模块记录,登记正式模块定义、模块标识和排序信息。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | POST |
| 请求路径 | /sys_base/platform/appModel/createAppModel |
| 来源文件 | 接口文档/01-新增模块.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
title | string | 是 | 中间件基础治理 | 模块名称 |
addonsType | string | 是 | sys_base | 模块标识 |
sort | number | 否 | 10 | 模块排序,值越小越靠前 |
description | string | 否 | 中间件正式基础治理模块 | 模块说明 |
path | string | 否 | moduleManage | 模块页面路径或展示路径 |
参数说明
title:模块名称。addonsType:模块标识。sort:模块排序,值越小越靠前。description:模块说明。path:模块页面路径或展示路径。
请求示例
json
{
"title": "中间件基础治理",
"addonsType": "sys_base",
"sort": 10,
"description": "中间件正式基础治理模块",
"path": "moduleManage"
}响应输出
json
{
"code": 0,
"msg": "创建成功",
"data": {}
}字段说明
| 字段名 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|
code | number | 0 | 业务状态码,0 表示成功 |
msg | string | 创建成功 | 返回消息 |
data | object | {} | 成功时返回空对象 |
curl 示例
bash
curl --location --request POST 'http://127.0.0.1:8100/sys_base/platform/appModel/createAppModel' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"title": "中间件基础治理",
"addonsType": "sys_base",
"sort": 10,
"description": "中间件正式基础治理模块",
"path": "moduleManage"
}'