接口文档

• GraphQL
  • post执行GraphQL查询
• 接口定义
  • get获取接口定义列表
  • post创建接口定义
  • post根据模型生成接口定义
  • put更新接口定义
  • del删除接口定义
  • patch更新接口定义(局部更新)
• 接口文档
  • get获取接口文档
• 接口日志
  • get获取接口日志列表
  • get统计接口日志
• 数据源
  • get获取所有数据源
  • post创建数据源
  • post获取物理数据库表名称
  • post验证数据源连接
  • put更新数据源
  • del删除数据源
  • post导入模型到数据源
  • post执行原生查询
  • post从数据源同步物理表到建模
• 概述
  • get获取概述
• 模型
  • get获取模型列表
  • post创建模型
  • put更新模型
  • del删除模型
  • post创建字段
  • put更新字段
  • del删除字段
  • post创建索引
  • put更新索引
  • del删除索引
• 系统
  • get获取系统配置
• 记录
  • get获取模型数据记录列表
  • post创建模型数据记录
  • get获取单条模型数据记录
  • put更新模型数据记录
  • del删除模型数据记录
  • patch更新模型数据记录(局部更新)
• 设置
  • get获取设置
  • patch保存设置
• 身份源
  • get获取身份源列表
  • post创建身份源
  • put更新身份源
  • del删除身份源

API docs by Redocly

Flexmodel API (0.0.1)

Download OpenAPI specification:Download

GraphQL

GraphQL接口信息

执行GraphQL查询

Request Body schema: application/json

operationName	string 操作名称
query	string 查询
	object 变量

Responses

https://preview.flexmodel.wetech.tech/fm-api/graphql

Request samples

• Payload

Content type

application/json

{

• "operationName": "string",
• "query": "string",
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errors": [

  • {

    • "message": "string",
    • "locations": [

      • {

        • "line": 0,
        • "column": 0,
        • "sourceName": "string"

        }

      ],
    • "errorType": { },
    • "path": [

      • null

      ],
    • "extensions": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "data": null,
• "dataPresent": true,
• "extensions": {

  • "property1": null,
  • "property2": null

  }

}

接口定义

接口定义管理

获取接口定义列表

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "children": [

  • {

    • "id": "string",
    • "name": "string",
    • "parentId": "string",
    • "type": "FOLDER",
    • "method": "string",
    • "path": "string",
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50",
    • "meta": null,
    • "enabled": true,
    • "children": [

      • { }

      ]

    }

  ]

}

创建接口定义

Request Body schema: application/json

id	string 唯一标识
type	string Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

根据模型生成接口定义

Request Body schema: application/json

datasourceName required	string\S
modelName required	string\S
apiFolder required	string\S
idFieldOfPath required	string\S
generateAPIs required	Array of strings non-empty

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis/generate

Request samples

• Payload

Content type

application/json

{

• "datasourceName": "string",
• "modelName": "string",
• "apiFolder": "string",
• "idFieldOfPath": "string",
• "generateAPIs": [

  • "string"

  ]

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

更新接口定义

path Parameters

id required

string

Request Body schema: application/json

id	string 唯一标识
type	string Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis/{id}

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

删除接口定义

path Parameters

id required

string

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

更新接口定义(局部更新)

path Parameters

id required

string

Request Body schema: application/json

id	string 唯一标识
type	string Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法

Responses

https://preview.flexmodel.wetech.tech/fm-api/apis/{id}

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET"

}

接口文档

接口文档管理

获取接口文档

Responses

https://preview.flexmodel.wetech.tech/fm-api/docs/openapi.json

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

接口日志

接口日志管理

获取接口日志列表

query Parameters

current	integer <int32> Default: 1 Example: current=1 当前页，默认值：1
pageSize	integer <int32> Default: 50 Example: pageSize=15 第几页，默认值：15
keyword	string 关键字
dateRange	string Example: dateRange=2025-01-01 00:00:00,2025-12-31 23:59:59 日期范围
level	string Example: level=INFO 日志等级

Responses

https://preview.flexmodel.wetech.tech/fm-api/logs

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": null,
• "list": [

  • {

    • "id": "string",
    • "uri": "string",
    • "level": "DEBUG",
    • "createdAt": "2022-03-10T12:15:50",
    • "data": null

    }

  ]

}

统计接口日志

query Parameters

keyword	string 关键字
dateRange	string Example: dateRange=2022-01-01 00:00:00,2022-01-01 23:59:59 日期范围
level	string Example: level=INFO 日志等级，支持传多个通过“,”分隔

Responses

https://preview.flexmodel.wetech.tech/fm-api/logs/stat

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "date": "string",
  • "total": 0

  }

]

数据源

数据源管理

获取所有数据源

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "type": "SYSTEM",
  • "config": { },
  • "enabled": true,
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]

创建数据源

Request Body schema: application/json

name	string 名称，需要唯一
type	string Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

获取物理数据库表名称

Request Body schema: application/json

name	string 名称，需要唯一
type	string Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/physics/names

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true

}

Response samples

• 200
• 400
• 500

Content type

application/json

[

• "string"

]

验证数据源连接

Request Body schema: application/json

name	string 名称，需要唯一
type	string Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/validate

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "success": null,
• "errorMsg": null,
• "time": null

}

更新数据源

path Parameters

datasourceName required

string 数据源名称

Request Body schema: application/json

name	string 名称，需要唯一
type	string Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

删除数据源

path Parameters

datasourceName required

string 数据源名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

导入模型到数据源

path Parameters

datasourceName required

string 数据源名称

Request Body schema: application/json

script required

string\S JSON脚本

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/import

Request samples

• Payload

Content type

application/json

{

• "script": "string"

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

执行原生查询

path Parameters

datasourceName required

string 数据源名称

Request Body schema: application/json

statement	string 语句
	object 参数

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/native-query

Request samples

• Payload

Content type

application/json

{

• "statement": "string",
• "parameters": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "time": null,
• "result": null

}

从数据源同步物理表到建模

path Parameters

datasourceName required

string 数据源名称

Request Body schema: application/json

Array

string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/sync

Request samples

• Payload

Content type

application/json

[

• "string"

]

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "type": "ENTITY",
  • "name": "Student",
  • "fields": [

    • {

      • "name": "id",
      • "type": "ID",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "generatedValue": "BIGINT_NOT_GENERATED"

      },
    • {

      • "name": "studentName",
      • "type": "String",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "length": 255

      },
    • {

      • "name": "gender",
      • "type": "Enum",
      • "from": "UserGender",
      • "multiple": false,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "interest",
      • "type": "Enum",
      • "from": "user_interest",
      • "multiple": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "age",
      • "type": "Int",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "classId",
      • "type": "Long",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentDetail",
      • "type": "Relation",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "multiple": false,
      • "from": "StudentDetail",
      • "localField": "id",
      • "foreignField": "studentId",
      • "cascadeDelete": true

      }

    ],
  • "indexes": [

    • {

      • "modelName": "Student",
      • "name": "IDX_studentName",
      • "fields": [

        • {

          • "fieldName": "studentName",
          • "direction": "ASC"

          }

        ],
      • "unique": false

      }

    ]

  }

]

概述

首页概览

获取概述

query Parameters

dateRange

string Example: dateRange=2025-01-01 00:00:00,2025-12-31 23:59:59 日期范围

Responses

https://preview.flexmodel.wetech.tech/fm-api/overview

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "queryCount": null,
• "mutationCount": null,
• "subscribeCount": null,
• "dataSourceCount": null

}

模型

模型管理

获取模型列表

path Parameters

datasourceName required

string 数据源名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

[

• {

  • "type": "ENTITY",
  • "name": "Student",
  • "fields": [

    • {

      • "name": "id",
      • "type": "ID",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "generatedValue": "BIGINT_NOT_GENERATED"

      },
    • {

      • "name": "studentName",
      • "type": "String",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "length": 255

      },
    • {

      • "name": "gender",
      • "type": "Enum",
      • "from": "UserGender",
      • "multiple": false,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "interest",
      • "type": "Enum",
      • "from": "user_interest",
      • "multiple": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "age",
      • "type": "Int",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "classId",
      • "type": "Long",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentDetail",
      • "type": "Relation",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "multiple": false,
      • "from": "StudentDetail",
      • "localField": "id",
      • "foreignField": "studentId",
      • "cascadeDelete": true

      }

    ],
  • "indexes": [

    • {

      • "modelName": "Student",
      • "name": "IDX_studentName",
      • "fields": [

        • {

          • "fieldName": "studentName",
          • "direction": "ASC"

          }

        ],
      • "unique": false

      }

    ]

  }

]

创建模型

path Parameters

datasourceName required

string 数据源名称

Request Body schema: application/json

Any of

name	string 名称
comment	string 注释
elements	Array of strings 元素列表
	object 用户自定义扩展属性
type	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models

Request samples

• Payload

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "ENTITY",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "ID",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "generatedValue": "BIGINT_NOT_GENERATED"

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "Enum",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "Enum",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "ENTITY",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "ID",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "generatedValue": "BIGINT_NOT_GENERATED"

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "Enum",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "Enum",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

更新模型

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

Request Body schema: application/json

Any of

name	string 名称
comment	string 注释
elements	Array of strings 元素列表
	object 用户自定义扩展属性
type	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}

Request samples

• Payload

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "ENTITY",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "ID",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "generatedValue": "BIGINT_NOT_GENERATED"

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "Enum",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "Enum",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "ENTITY",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "ID",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "generatedValue": "BIGINT_NOT_GENERATED"

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "Enum",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "Enum",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

删除模型

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

创建字段

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

Request Body schema: application/json

name	string 名称
type	string 类型
comment	string 注释
unique	boolean 是否唯一
nullable	boolean 可为空
defaultValue	any 默认值
	object 用户自定义扩展属性
modelName	string
concreteType	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/fields

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": null,
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "concreteType": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": null,
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "concreteType": "string"

}

更新字段

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
fieldName required	string 字段名称

Request Body schema: application/json

name	string 名称
type	string 类型
comment	string 注释
unique	boolean 是否唯一
nullable	boolean 可为空
defaultValue	any 默认值
	object 用户自定义扩展属性
modelName	string
concreteType	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/fields/{fieldName}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": null,
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "concreteType": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": null,
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "concreteType": "string"

}

删除字段

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
fieldName required	string 字段名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/fields/{fieldName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

创建索引

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

Request Body schema: application/json

name	string 名称
	Array of objects (Field) 字段列表
unique	boolean 是否唯一
modelName	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/indexes

Request samples

• Payload

Content type

application/json

{

• "modelName": "Student",
• "name": "IDX_studentName",
• "fields": [

  • {

    • "fieldName": "studentName",
    • "direction": "ASC"

    }

  ],
• "unique": false

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "modelName": "Student",
• "name": "IDX_studentName",
• "fields": [

  • {

    • "fieldName": "studentName",
    • "direction": "ASC"

    }

  ],
• "unique": false

}

更新索引

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
indexName required	string 索引名称

Request Body schema: application/json

name	string 名称
	Array of objects (Field) 字段列表
unique	boolean 是否唯一
modelName	string

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/indexes/{indexName}

Request samples

• Payload

Content type

application/json

{

• "modelName": "Student",
• "name": "IDX_studentName",
• "fields": [

  • {

    • "fieldName": "studentName",
    • "direction": "ASC"

    }

  ],
• "unique": false

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "modelName": "Student",
• "name": "IDX_studentName",
• "fields": [

  • {

    • "fieldName": "studentName",
    • "direction": "ASC"

    }

  ],
• "unique": false

}

删除索引

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
indexName required	string 索引名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/indexes/{indexName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

系统

系统信息

获取系统配置

Responses

https://preview.flexmodel.wetech.tech/fm-api/system/profile

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "env": null,
• "properties": null,
• "application": null,
• "settings": null

}

记录

模型数据记录管理

获取模型数据记录列表

path Parameters

datasourceName required	string 模型名称
modelName required	string

query Parameters

current	integer <int32> Default: 1 Example: current=1 当前页，默认值：1
pageSize	integer <int32> Default: 15 Example: pageSize=15 第几页，默认值：15
filter	string Example: filter="{ \"username\": { \"_eq\": \"john_doe\" } }" 查询条件，更多信息见查询条件文档
nestedQuery	boolean Default: false 是否开启嵌套子查询，开启则查询关联数据，只查询5层，默认值false
sort	string Example: sort="[{\"field\":\"name\",\"direction\":\"ASC\"}, {\"field\":\"id\",\"direction\":\"DESC\"}]" 排序

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": null,
• "list": [

  • { }

  ]

}

创建模型数据记录

path Parameters

datasourceName required	string 模型名称
modelName required	string

Request Body schema: application/json

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records

Request samples

• Payload

Content type

application/json

{

• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

获取单条模型数据记录

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Example: 1 ID

query Parameters

nestedQuery

boolean Default: false

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

更新模型数据记录

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Example: 1 ID

Request Body schema: application/json

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

删除模型数据记录

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Example: 1 ID

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

更新模型数据记录(局部更新)

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Example: 1 ID

Request Body schema: application/json

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/fm-api/datasources/{datasourceName}/models/{modelName}/records/{id}

Request samples

• Payload

Content type

application/json

{

• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

设置

系统设置

获取设置

Responses

https://preview.flexmodel.wetech.tech/fm-api/settings

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointEnabled": true,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

保存设置

Request Body schema: application/json

appName	string
	object (Log)
	object (Security)
	object (Proxy)

Responses

https://preview.flexmodel.wetech.tech/fm-api/settings

Request samples

• Payload

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointEnabled": true,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointEnabled": true,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

身份源

身份源管理

获取身份源列表

Responses

https://preview.flexmodel.wetech.tech/fm-api/identity-providers

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "provider": { },
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]

创建身份源

Request Body schema: application/json

name	string 名称，需要唯一
provider	object 身份源配置

Responses

https://preview.flexmodel.wetech.tech/fm-api/identity-providers

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "provider": { }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

更新身份源

path Parameters

name required

string 名称

Request Body schema: application/json

name	string 名称，需要唯一
provider	object 身份源配置

Responses

https://preview.flexmodel.wetech.tech/fm-api/identity-providers/{name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "provider": { }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

删除身份源

path Parameters

name required

string 名称

Responses

https://preview.flexmodel.wetech.tech/fm-api/identity-providers/{name}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}