![]()
![]()
ERD Online 是全球第一个开源、免费在线数据建模、元数据管理平台。提供简单易用的元数据设计、关系图设计、SQL查询等功能，辅以版本、导入、导出、数据源、SQL解析、审计、团队协作等功能、方便我们快速、安全的管理数据库中的元数据。
从4.0.10版本开始，ERD Online通过api，提供接入接出能力，可以自由对接现有的系统、或者基于ERD Online元数据，围绕元数据打造数据生态。
元数据分组API
❝
元数据分组指的是：项目中的模块
ERD Online 基于现有元数据结构，对外暴露元数据分组API，可以对元数据分组进行增删改查
对于新增、修改接口，后台会校验json schema，保证元数据数据结构不会被破坏。
对于查询、删除接口，后台则不会校验json schema。
版本要求：ERD Online版本 >= 4.0.10
其余API后续陆续开放
❞
API一览
![]()
新增模块
POST /project/{id}/module
说明
新增模块
参数
| 类型 |
名称 |
说明 |
类型 |
| 「Path」 |
「id」 必填 |
id |
string |
| 「Body」 |
「json」 必填 |
json |
< string, object > map |
响应
| HTTP代码 |
说明 |
类型 |
| 「200」 |
OK |
R |
| 「201」 |
Created |
无内容 |
| 「401」 |
Unauthorized |
无内容 |
| 「403」 |
Forbidden |
无内容 |
| 「404」 |
Not Found |
无内容 |
Content-type
HTTP请求示例
请求 path
/project/string/module
请求 body
json :{}
HTTP响应示例
响应 200
{
"code" : 0,
"data" : "object",
"msg" : "string"
}
修改模块Json
PUT /project/{id}/module
说明
修改模块Json
参数
| 类型 |
名称 |
说明 |
类型 |
| 「Path」 |
「id」 必填 |
id |
string |
| 「Query」 |
「name」 必填 |
name |
string |
| 「Query」 |
「path」 可选 |
path |
string |
| 「Body」 |
「json」 必填 |
json |
< string, object > map |
响应
| HTTP代码 |
说明 |
类型 |
| 「200」 |
OK |
R |
| 「201」 |
Created |
无内容 |
| 「401」 |
Unauthorized |
无内容 |
| 「403」 |
Forbidden |
无内容 |
| 「404」 |
Not Found |
无内容 |
Content-type
HTTP请求示例
请求 path
/project/string/module
请求 query
{
"name" : "string",
"path" : "string"
}
请求 body
json :{}
HTTP响应示例
响应 200
{
"code" : 0,
"data" : "object",
"msg" : "string"
}
删除模块
DELETE /project/{id}/module
说明
删除模块
参数
| 类型 |
名称 |
说明 |
类型 |
| 「Path」 |
「id」 必填 |
id |
string |
| 「Query」 |
「name」 必填 |
name |
string |
| 「Query」 |
「path」 可选 |
path |
string |
响应
| HTTP代码 |
说明 |
类型 |
| 「200」 |
OK |
R |
| 「204」 |
No Content |
无内容 |
| 「401」 |
Unauthorized |
无内容 |
| 「403」 |
Forbidden |
无内容 |
HTTP请求示例
请求 path
/project/string/module
请求 query
{
"name" : "string",
"path" : "string"
}
HTTP响应示例
响应 200
{
"code" : 0,
"data" : "object",
"msg" : "string"
}
根据模块名称获取单个模块json
GET /project/{id}/module/json
说明
根据模块名称获取单个模块json
参数
| 类型 |
名称 |
说明 |
类型 |
| 「Path」 |
「id」 必填 |
id |
string |
| 「Query」 |
「name」 必填 |
name |
string |
响应
| HTTP代码 |
说明 |
类型 |
| 「200」 |
OK |
R |
| 「401」 |
Unauthorized |
无内容 |
| 「403」 |
Forbidden |
无内容 |
| 「404」 |
Not Found |
无内容 |
HTTP请求示例
请求 path
/project/string/module/json
请求 query
{
"name" : "string"
}
HTTP响应示例
响应 200
{
"code" : 0,
"data" : "object",
"msg" : "string"
}
根据模块名称获取json path
GET /project/{id}/module/path
说明
根据模块名称获取json path
参数
| 类型 |
名称 |
说明 |
类型 |
| 「Path」 |
「id」 必填 |
id |
string |
| 「Query」 |
「name」 必填 |
name |
string |
响应
| HTTP代码 |
说明 |
类型 |
| 「200」 |
OK |
R |
| 「401」 |
Unauthorized |
无内容 |
| 「403」 |
Forbidden |
无内容 |
| 「404」 |
Not Found |
无内容 |
HTTP请求示例
请求 path
/project/string/module/path
请求 query
{
"name" : "string"
}
HTTP响应示例
响应 200
{
"code" : 0,
"data" : "object",
"msg" : "string"
}
交流渠道
元数据 ERD Online 体验：https://erd.zerocode.net.cn
元数据 ERD Online 文档：https://portal.zerocode.net.cn
低代码 论坛：https://github.com/www-zerocode-net-cn/ERD-Online/discussions
低代码 LOCO 体验：https://loco.zerocode.net.cn
