2020-09-08

Api Documentation

简介:Api Documentation

HOST:http://192.168.13.233:8099

联系人:

Version:1.0

接口路径:/v3/api-docs

[TOC]

Admin登入登出

主页

接口地址:/

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 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 面积/m² false string
  coatingPerGram 涂布克重/g false string
  id 主键ID false integer(int64)
  lineNo 产线编号 false string
  status 状态 false string

响应状态:

状态码 说明 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 面积/m² false string
  coatingPerGram 涂布克重/g false string
  id 主键ID false integer(int64)
  lineNo 产线编号 false string
  status 状态 false string

响应状态:

状态码 说明 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)

响应状态:

状态码 说明 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 面积/m² string
  coatingPerGram 涂布克重/g string
  createTime 创建时间 string(date-time)
  id 主键ID integer(int64)
  lineNo 产线编号 string
  status 状态 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 创建结束日期 query false string(date-time)
createStartTime 创建开始日期 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)

响应状态:

状态码 说明 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 面积/m² string
  coatingPerGram 涂布克重/g string
  createTime 创建时间 string(date-time)
  id 主键ID integer(int64)
  lineNo 产线编号 string
  status 状态 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)

响应状态:

状态码 说明 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 面积/m² 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 状态 false string

响应状态:

状态码 说明 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 面积/m² 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 状态 false string

响应状态:

状态码 说明 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)

响应状态:

状态码 说明 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

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:PATCH

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:OPTIONS

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:TRACE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

暂无

响应示例:

error

接口地址:/error

请求方式:HEAD

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 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)

响应状态:

状态码 说明 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

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 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)

响应状态:

状态码 说明 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

响应状态:

状态码 说明 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

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 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": ""
}
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容