Api Documentation
簡介:Api Documentation
HOST:http://192.168.13.233:8099
聯(lián)系人:
Version:1.0
接口路徑:/v3/api-docs
[TOC]
Admin登入登出
主頁
接口地址:/
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
BOM表管理
新增BOM表
接口地址:/bom/add
請求方式:POST
請求數據類型:application/x-www-form-urlencoded,application/json
響應數據類型:*/*
接口描述:
請求示例:
{
"bomName": "",
"bomNo": "",
"coatingArea": "",
"coatingPerGram": "",
"id": 0,
"lineNo": "",
"status": ""
}
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bOM表 | BOM表 | body | true | BOM表 | BOM表 |
??bomName | 產線名稱 | false | string | ||
??bomNo | BOM編號 | false | string | ||
??coatingArea | 面積/m2 | false | string | ||
??coatingPerGram | 涂布克重/g | false | string | ||
??id | 主鍵ID | false | integer(int64) | ||
??lineNo | 產線編號 | false | string | ||
??status | 狀態(tài) | false | string |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
更新BOM表
接口地址:/bom/edit
請求方式:PUT
請求數據類型:application/x-www-form-urlencoded,application/json
響應數據類型:*/*
接口描述:
請求示例:
{
"bomName": "",
"bomNo": "",
"coatingArea": "",
"coatingPerGram": "",
"id": 0,
"lineNo": "",
"status": ""
}
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bOM表 | BOM表 | body | true | BOM表 | BOM表 |
??bomName | 產線名稱 | false | string | ||
??bomNo | BOM編號 | false | string | ||
??coatingArea | 面積/m2 | false | string | ||
??coatingPerGram | 涂布克重/g | false | string | ||
??id | 主鍵ID | false | integer(int64) | ||
??lineNo | 產線編號 | false | string | ||
??status | 狀態(tài) | false | string |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
根據ID獲取BOM表
接口地址:/bom/get/{bomId}
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bomId | bomId | path | true | integer(int64) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result?BomVo? |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | BomVo | BomVo | |
??bomName | 產線名稱 | string | |
??bomNo | BOM編號 | string | |
??coatingArea | 面積/m2 | string | |
??coatingPerGram | 涂布克重/g | string | |
??createTime | 創(chuàng)建時間 | string(date-time) | |
??id | 主鍵ID | integer(int64) | |
??lineNo | 產線編號 | string | |
??status | 狀態(tài) | string | |
??updateTime | 更新時間 | string(date-time) | |
msg | string |
響應示例:
{
"code": 0,
"data": {
"bomName": "",
"bomNo": "",
"coatingArea": "",
"coatingPerGram": "",
"createTime": "",
"id": 0,
"lineNo": "",
"status": "",
"updateTime": ""
},
"msg": ""
}
獲取BOM表列表
接口地址:/bom/list
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
createEndTime | 創(chuàng)建結束日期 | query | false | string(date-time) | |
createStartTime | 創(chuàng)建開始日期 | query | false | string(date-time) | |
endTime | query | false | string(date-time) | ||
keyword | 搜索關鍵字 | query | false | string | |
length | query | false | integer(int32) | ||
orderBy | query | false | string | ||
pageNum | 分頁 | query | false | integer(int32) | |
pageSize | 分頁 | query | false | integer(int32) | |
pageable | 是否分頁(默認True) | query | false | boolean | |
start | query | false | integer(int32) | ||
startTime | query | false | string(date-time) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result?BomVo? |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | BomVo | BomVo | |
??bomName | 產線名稱 | string | |
??bomNo | BOM編號 | string | |
??coatingArea | 面積/m2 | string | |
??coatingPerGram | 涂布克重/g | string | |
??createTime | 創(chuàng)建時間 | string(date-time) | |
??id | 主鍵ID | integer(int64) | |
??lineNo | 產線編號 | string | |
??status | 狀態(tài) | string | |
??updateTime | 更新時間 | string(date-time) | |
msg | string |
響應示例:
{
"code": 0,
"data": {
"bomName": "",
"bomNo": "",
"coatingArea": "",
"coatingPerGram": "",
"createTime": "",
"id": 0,
"lineNo": "",
"status": "",
"updateTime": ""
},
"msg": ""
}
刪除BOM表
接口地址:/bom/remove
請求方式:DELETE
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bomId | bomId | query | true | integer(int64) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
BOM詳情管理
新增BOM詳情
接口地址:/bomDetail/add
請求方式:POST
請求數據類型:application/x-www-form-urlencoded,application/json
響應數據類型:*/*
接口描述:
請求示例:
{
"bomId": 0,
"coatingArea": "",
"coatingPerGram": "",
"formulaAddition": "",
"id": 0,
"manufacturers": "",
"materialName": "",
"materialNo": "",
"model": "",
"rawMaterialSolidContent": "",
"sn": 0,
"solidContent": "",
"solidContentProportion": "",
"status": ""
}
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bOM詳情 | BOM詳情 | body | true | BOM詳情 | BOM詳情 |
??bomId | BOMID | false | integer(int64) | ||
??coatingArea | 面積/m2 | false | string | ||
??coatingPerGram | 涂布克重/g | false | string | ||
??formulaAddition | 配方加入量(單位kg) | false | string | ||
??id | 主鍵ID | false | integer(int64) | ||
??manufacturers | 廠家 | false | string | ||
??materialName | 物料名稱 | false | string | ||
??materialNo | 物料代號 | false | string | ||
??model | 型號 | false | string | ||
??rawMaterialSolidContent | 原料固含 | false | string | ||
??sn | SN | false | integer(int32) | ||
??solidContent | 固體含量 | false | string | ||
??solidContentProportion | 固含占比 | false | string | ||
??status | 狀態(tài) | false | string |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
更新BOM詳情
接口地址:/bomDetail/edit
請求方式:PUT
請求數據類型:application/x-www-form-urlencoded,application/json
響應數據類型:*/*
接口描述:
請求示例:
{
"bomId": 0,
"coatingArea": "",
"coatingPerGram": "",
"formulaAddition": "",
"id": 0,
"manufacturers": "",
"materialName": "",
"materialNo": "",
"model": "",
"rawMaterialSolidContent": "",
"sn": 0,
"solidContent": "",
"solidContentProportion": "",
"status": ""
}
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bOM詳情 | BOM詳情 | body | true | BOM詳情 | BOM詳情 |
??bomId | BOMID | false | integer(int64) | ||
??coatingArea | 面積/m2 | false | string | ||
??coatingPerGram | 涂布克重/g | false | string | ||
??formulaAddition | 配方加入量(單位kg) | false | string | ||
??id | 主鍵ID | false | integer(int64) | ||
??manufacturers | 廠家 | false | string | ||
??materialName | 物料名稱 | false | string | ||
??materialNo | 物料代號 | false | string | ||
??model | 型號 | false | string | ||
??rawMaterialSolidContent | 原料固含 | false | string | ||
??sn | SN | false | integer(int32) | ||
??solidContent | 固體含量 | false | string | ||
??solidContentProportion | 固含占比 | false | string | ||
??status | 狀態(tài) | false | string |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
刪除BOM詳情
接口地址:/bomDetail/remove
請求方式:DELETE
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
bomDetailId | bomDetailId | query | true | integer(int64) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
Error
error
接口地址:/error
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:POST
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:PUT
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:DELETE
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:PATCH
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:OPTIONS
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:TRACE
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
暫無
響應示例:
error
接口地址:/error
請求方式:HEAD
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | |
204 | No Content | |
401 | Unauthorized | |
403 | Forbidden |
響應參數:
暫無
響應示例:
data-gather-controller
exportCsv
接口地址:/dataGather/exportCsv
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
endTime | query | false | string(date-time) | ||
keyword | 搜索關鍵字 | query | false | string | |
length | query | false | integer(int32) | ||
orderBy | query | false | string | ||
pageNum | 分頁 | query | false | integer(int32) | |
pageSize | 分頁 | query | false | integer(int32) | |
pageable | 是否分頁(默認True) | query | false | boolean | |
pointNoList | query | false | array | string | |
start | query | false | integer(int32) | ||
startTime | query | false | string(date-time) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
listAllPointInfo
接口地址:/dataGather/listAllPointInfo
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
listPointData
接口地址:/dataGather/listPointData
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
endTime | query | false | string(date-time) | ||
keyword | 搜索關鍵字 | query | false | string | |
length | query | false | integer(int32) | ||
orderBy | query | false | string | ||
pageNum | 分頁 | query | false | integer(int32) | |
pageSize | 分頁 | query | false | integer(int32) | |
pageable | 是否分頁(默認True) | query | false | boolean | |
pointNoList | query | false | array | string | |
start | query | false | integer(int32) | ||
startTime | query | false | string(date-time) |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
test-controller
echo
接口地址:/test/echo
請求方式:GET
請求數據類型:application/x-www-form-urlencoded
響應數據類型:*/*
接口描述:
請求參數:
參數名稱 | 參數說明 | 請求類型 | 是否必須 | 數據類型 | schema |
---|---|---|---|---|---|
data | data | query | false | string |
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}
文件處理
文件上傳
接口地址:/file/fileUpload
請求方式:POST
請求數據類型:application/x-www-form-urlencoded,application/json,application/octet-stream
響應數據類型:*/*
接口描述:
請求參數:
暫無
響應狀態(tài):
狀態(tài)碼 | 說明 | schema |
---|---|---|
200 | OK | Result |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
響應參數:
參數名稱 | 參數說明 | 類型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
響應示例:
{
"code": 0,
"data": {},
"msg": ""
}