跳到主要内容

创建数据模型

提示

在数据模型、接口入参定义或接口响应期望定义中,会经常使用到数据结构来可视化定义jsonschema,以便用来设计接口

创建数据模型

新建模型入口

image.png

提示
  • 模型名称:必填,且必须是唯一的,常为字母、数字、下划线构成
  • 别名:一般为中文名,方便查找和查看
  • 目录:可以将模型分类管理
  • 备注:用于备注说明描述模型的作用

image.png

编辑数据模型

image.png

智能导入

如果已经有现成的结构文件,可以通过智能导入的方式,快速生成jsonschema的结构,避免了手动输入的繁琐,目前支持jsonxmljsonschemamysql ddl 格式的智能导入

image.png

Json示例

{
"userInfo_get_response":{
"result":{
"model":{
"open_id":"qwertyuiuduiasd",
"avatar":"avatar url",
"nick":"snsNick"
},
"err_message":"err_message",
"err_code":"err_code",
"success":false
}
}
}

image.png

Xml示例

**<error_response>
<code>50</code>
<msg>Remote service error</msg>
<sub_code>isv.invalid-parameter</sub_code>
<sub_msg>非法参数</sub_msg>
</error_response>**

image.png

Jsonschema示例

{  
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Person Schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person.",
"minLength": 2
},
"age": {
"description": "Age in years which must be equal to or greater than zero.",
"type": "integer",
"minimum": 0
},
"email": {
"type": "string",
"description": "The email address of the person.",
"format": "email"
}
},
"required": ["name", "age", "email"]
}

image.png

Mysql DDL示例

CREATE TABLE orders (  
order_id INT AUTO_INCREMENT PRIMARY KEY,
customer_id INT NOT NULL,
order_date DATE NOT NULL,
total_amount DECIMAL(10, 2) NOT NULL,
status VARCHAR(50) NOT NULL,
FOREIGN KEY (customer_id) REFERENCES customers(customer_id)
);

image.png

字段高级设置

除了基础的设置字段是否必填、是否允许为空,一些特殊类型的字段也支持高级设置或直接通过源码编辑设置字段属性,例如array(数组),可以设置item(元素)个数等信息

image.png

String

image.png

Number

image.png

Array

image.png

Object

image.png

Boolean

image.png

Integer

image.png

Oneof、Anyof、Allof

image.png

引用数据模型

添加子节点时,支持快速引用已创建好的数据模型(数据模型)

image.png

预览

预览数据结构生成的json内容

image.png

Raw编辑

通过编辑jsonschema源码设计数据结构

image.png