Version Update Time Status Author Description

v2022-01-18 13:50:20

2022-01-18 13:50:20

auto

@finegirl

Created by smart-doc

1. 模块

1.1. 查询模块

Type: POST

Content-Type: application/json; charset=utf-8

Description:  查询模块

Body-parameters:

Parameter Type Description Required Since

id

object

No comments found.

false

-

createTime

string

No comments found.

false

-

createUser

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

deleted

int32

No comments found.

false

-

createUserName

string

No comments found.

false

-

createUserDeptId

int64

No comments found.

false

-

createUserDeptName

string

No comments found.

false

-

updateTime

string

No comments found.

false

-

updateUser

string

No comments found.

false

-

updateUserId

int64

No comments found.

false

-

updateUserName

string

No comments found.

false

-

updateUserDeptId

int64

No comments found.

false

-

updateUserDeptName

string

No comments found.

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

modelName

string

模块名称

false

-

modelCode

string

模块编码

false

-

modelIcon

string

模块图标

false

-

modelUrl

string

模块地址

false

-

remark

string

备注信息

false

-

idStart

int64

开始 序号,主键,自增长

false

-

idEnd

int64

结束 序号,主键,自增长

false

-

idIncrement

int64

增加 序号,主键,自增长

false

-

idList

array

序号,主键,自增长列表

false

-

modelNameList

array

模块名称

false

-

modelCodeList

array

模块编码

false

-

modelIconList

array

模块图标

false

-

modelUrlList

array

模块地址

false

-

remarkList

array

备注信息

false

-

sortStart

int32

开始 排序

false

-

sortEnd

int32

结束 排序

false

-

sortIncrement

int32

增加 排序

false

-

sortList

array

排序列表

false

-

createTimeStart

string

开始 创建时间

false

-

createTimeEnd

string

结束 创建时间

false

-

createUserIdStart

int64

开始 创建用户

false

-

createUserIdEnd

int64

结束 创建用户

false

-

createUserIdIncrement

int64

增加 创建用户

false

-

createUserIdList

array

创建用户列表

false

-

updateTimeStart

string

开始 修改时间

false

-

updateTimeEnd

string

结束 修改时间

false

-

orConditionList

array

OR条件集合,列表项之间是OR,项内容之间是AND,如:(list[0].1 and list[0].2) or (list[1].3 and list[1].4)

false

-

andConditionList

array

AND条件集合,列表项之间是AND,项内容之间是OR,如:(list[0].1 or list[0].2) and (list[1].3 or list[1].4)

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost/model/list --data '{
  "id": "eo397j",
  "createTime": "2022-01-18 13:50:26",
  "createUser": "kmy3j5",
  "createUserId": 20,
  "deleted": 46,
  "createUserName": "ophelia.batz",
  "createUserDeptId": 198,
  "createUserDeptName": "ophelia.batz",
  "updateTime": "2022-01-18 13:50:26",
  "updateUser": "7nphjt",
  "updateUserId": 106,
  "updateUserName": "ophelia.batz",
  "updateUserDeptId": 919,
  "updateUserDeptName": "ophelia.batz",
  "page": 1,
  "size": 10,
  "modelName": "ophelia.batz",
  "modelCode": "92819",
  "modelIcon": "f7ekob",
  "modelUrl": "www.benton-treutel.co",
  "remark": "8s9ghb",
  "idStart": 161,
  "idEnd": 941,
  "idIncrement": 806,
  "idList": [
    850
  ],
  "modelNameList": [
    "viue92"
  ],
  "modelCodeList": [
    "xg6p4b"
  ],
  "modelIconList": [
    "auav3x"
  ],
  "modelUrlList": [
    "f86j2s"
  ],
  "remarkList": [
    "fiyfo9"
  ],
  "sortStart": 455,
  "sortEnd": 954,
  "sortIncrement": 753,
  "sortList": [
    326
  ],
  "createTimeStart": "lsd7us",
  "createTimeEnd": "kd8nig",
  "createUserIdStart": 117,
  "createUserIdEnd": 43,
  "createUserIdIncrement": 570,
  "createUserIdList": [
    397
  ],
  "updateTimeStart": "2htlge",
  "updateTimeEnd": "rhu8cj",
  "orConditionList": [
    {
      "$ref": ".."
    }
  ],
  "andConditionList": [
    {
      "$ref": ".."
    }
  ]
}'

Response-example:

string

1.2. 编辑模块

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description:  编辑模块

Query-parameters:

Parameter Type Description Required Since

id

int64

No comments found.

false

-

Request-example:

curl -X GET -i http://localhost/model/edit?id=820

Response-example:

string

1.3. 保存模块

Type: POST

Content-Type: application/json; charset=utf-8

Description:  保存模块

Body-parameters:

Parameter Type Description Required Since

id

object

No comments found.

false

-

createTime

string

No comments found.

false

-

createUser

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

deleted

int32

No comments found.

false

-

createUserName

string

No comments found.

false

-

createUserDeptId

int64

No comments found.

false

-

createUserDeptName

string

No comments found.

false

-

updateTime

string

No comments found.

false

-

updateUser

string

No comments found.

false

-

updateUserId

int64

No comments found.

false

-

updateUserName

string

No comments found.

false

-

updateUserDeptId

int64

No comments found.

false

-

updateUserDeptName

string

No comments found.

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

modelName

string

模块名称

false

-

modelCode

string

模块编码

false

-

modelIcon

string

模块图标

false

-

modelUrl

string

模块地址

false

-

remark

string

备注信息

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost/model/save --data '{
  "id": "dxh4iu",
  "createTime": "2022-01-18 13:50:26",
  "createUser": "a1s4j2",
  "createUserId": 349,
  "deleted": 249,
  "createUserName": "ophelia.batz",
  "createUserDeptId": 77,
  "createUserDeptName": "ophelia.batz",
  "updateTime": "2022-01-18 13:50:26",
  "updateUser": "01us8p",
  "updateUserId": 972,
  "updateUserName": "ophelia.batz",
  "updateUserDeptId": 691,
  "updateUserDeptName": "ophelia.batz",
  "page": 1,
  "size": 10,
  "modelName": "ophelia.batz",
  "modelCode": "92819",
  "modelIcon": "2mk03a",
  "modelUrl": "www.benton-treutel.co",
  "remark": "nzjlh6"
}'

Response-example:

string

1.4. 删除模块

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description:  删除模块

Query-parameters:

Parameter Type Description Required Since

id

string

No comments found.

false

-

Request-example:

curl -X GET -i http://localhost/model/delete?id=195

Response-example:

string

1.5. 查看模块

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description:  查看模块

Query-parameters:

Parameter Type Description Required Since

id

int64

No comments found.

false

-

Request-example:

curl -X GET -i http://localhost/model/info?id=114

Response-example:

string

1.6. 逻辑删除模块

Type: POST

Content-Type: application/json; charset=utf-8

Description:  逻辑删除模块

Body-parameters:

Parameter Type Description Required Since

id

object

No comments found.

false

-

createTime

string

No comments found.

false

-

createUser

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

deleted

int32

No comments found.

false

-

createUserName

string

No comments found.

false

-

createUserDeptId

int64

No comments found.

false

-

createUserDeptName

string

No comments found.

false

-

updateTime

string

No comments found.

false

-

updateUser

string

No comments found.

false

-

updateUserId

int64

No comments found.

false

-

updateUserName

string

No comments found.

false

-

updateUserDeptId

int64

No comments found.

false

-

updateUserDeptName

string

No comments found.

false

-

page

int32

No comments found.

false

-

size

int32

No comments found.

false

-

modelName

string

模块名称

false

-

modelCode

string

模块编码

false

-

modelIcon

string

模块图标

false

-

modelUrl

string

模块地址

false

-

remark

string

备注信息

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost/model/logicDelete --data '{
  "id": "5aele2",
  "createTime": "2022-01-18 13:50:26",
  "createUser": "wgkyrw",
  "createUserId": 672,
  "deleted": 565,
  "createUserName": "ophelia.batz",
  "createUserDeptId": 702,
  "createUserDeptName": "ophelia.batz",
  "updateTime": "2022-01-18 13:50:26",
  "updateUser": "zrbex8",
  "updateUserId": 263,
  "updateUserName": "ophelia.batz",
  "updateUserDeptId": 491,
  "updateUserDeptName": "ophelia.batz",
  "page": 1,
  "size": 10,
  "modelName": "ophelia.batz",
  "modelCode": "92819",
  "modelIcon": "7qc8ts",
  "modelUrl": "www.benton-treutel.co",
  "remark": "xiko1i"
}'

Response-example:

string

1.7. 模块导入模板下载

Type: POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description:  模块导入模板下载

Request-example:

curl -X POST -i http://localhost/model/downloadTemplate

Response-example:

Return void.

1.8. 模块导入

Type: POST

Content-Type: multipart/form-data

Description:  模块导入

Query-parameters:

Parameter Type Description Required Since

file

file

No comments found.

true

-

updateSupport

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -i http://localhost/model/importData --data 'updateSupport=true'

Response-example:

string

2. 错误码列表

Error code Description

200

ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

Top