VersionUpdate TimeStatusAuthorDescription

0.0.1

2023-03-06 17:25:00

创建文档

浮生

初始化接口文档

1. 

1.1. 获取文件路径链接

Type: POST

Author: 27951

Content-Type: multipart/form-data

Description: 获取文件路径链接

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

No comments found.(array of file)

true

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -i http://localhost:8888/reporting/file/fileUpDown

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "oa6ohm"
}

2. 报备模块

2.1. 信息上传

Type: POST

Author: 27951

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

Description: 信息上传

Body-parameters:

ParameterTypeDescriptionRequiredSince

name

string

姓名

true

-

phone

string

手机号

true

-

wxPhone

string

微信绑定手机号

false

-

company

string

单位名称

true

-

customerName

string

客户名称

true

-

entryName

string

项目名称

true

-

projectAmount

string

项目金额

true

-

tenderTime

string

预计投标时间

true

-

content

string

项目基本情况

false

-

parameters

string

控标参数-----新需求

false

-

trade

string

所属行业

true

-

licensing

string

是否授权-----新需求

true

-

product

string

No comments found.

false

-

bProduct

array

产品类型

true

-

bFile

array

No comments found.

false

-

file

string

No comments found.

false

-

code

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/informationReporting/add --data '{
  "name": "梓晨.蔡",
  "phone": "17839278351",
  "wxPhone": "17839278351",
  "company": "洪-姚",
  "customerName": "梓晨.蔡",
  "entryName": "梓晨.蔡",
  "projectAmount": "c32rvd",
  "tenderTime": "2023-10-24 17:49:04",
  "content": "keol9r",
  "parameters": "a54f8p",
  "trade": "fbw4n6",
  "licensing": "w7y318",
  "product": "9zs20z",
  "bProduct": [
    "tnk7jk"
  ],
  "bFile": [
    "4l0ljt"
  ],
  "file": "4ptzg9",
  "code": "48406"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "gn5hka"
}

2.2. 删除信息

Type: DELETE

Author: 27951

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

Description: 删除信息

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

调用者id(管理员 上传信息的人)

false

-

name

string

调用者姓名(管理员 上传信息的人)

false

-

ids

array

id数组

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/delete --data '{
  "id": 16,
  "name": "梓晨.蔡",
  "ids": [
    223
  ]
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "ef9kfr"
}

2.3. 关闭项目

Type: DELETE

Author: 27951

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

Description: 关闭项目

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

调用者id(管理员 上传信息的人)

false

-

name

string

调用者姓名(管理员 上传信息的人)

false

-

itemId

int64

项目id

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/close --data '{
  "id": 960,
  "name": "梓晨.蔡",
  "itemId": 579
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "0dvcwq"
}

2.4. 

Type: DELETE

Author: "Astrid"

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

调用者id(管理员 上传信息的人)

false

-

name

string

调用者姓名(管理员 上传信息的人)

false

-

itemId

int64

项目id

false

-

ps

string

订阅消息---备注

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/valid --data '{
  "id": 874,
  "name": "梓晨.蔡",
  "itemId": 658,
  "ps": "2dbge1"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "xccqxf"
}

2.5. 

Type: DELETE

Author: "Astrid"

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

调用者id(管理员 上传信息的人)

false

-

name

string

调用者姓名(管理员 上传信息的人)

false

-

itemId

int64

项目id

false

-

ps

string

订阅消息---备注

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/invalid --data '{
  "id": 39,
  "name": "梓晨.蔡",
  "itemId": 309,
  "ps": "rt0q20"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "9vhojl"
}

2.6. 项目列表

Type: GET

Author: 27951

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

Description: 项目列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

name

string

姓名

false

-

company

string

单位名称

false

-

trade

string

所属行业

false

-

delStatus

int32

删除状态:0删除 1正常

false

-

status

int32

项目状态:0已关闭 1进行中

false

-

reportingTime

string

创建时间

false

-

currPage

int32

当前页,默认1

false

-

pageSize

int32

每页大小,默认10

false

-

orderField

string

排序字段,可选择值参考返回结果

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://localhost:8888/reporting/informationReporting/list?status=396&order=dk5j21&pageSize=10&orderField=ccml5g&delStatus=689&currPage=1&name=梓晨.蔡&trade=03ppmv&reportingTime=2023-10-24 17:49:04&company=洪-姚

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

id

-

     └─userName

string

用户名

-

     └─name

string

管理员姓名

-

     └─password

string

密码

-

     └─adminType

int32

角色类别 1超级管理员、2管理员

-

     └─time

string

创建时间

-

     └─status

int32

状态(0停用 1正常)

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": {
    "totalCount": 759,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 233,
        "userName": "梓晨.蔡",
        "name": "梓晨.蔡",
        "password": "t6g2ai",
        "adminType": 365,
        "time": "2023-10-24 17:49:04",
        "status": 28
      }
    ]
  }
}

2.7. 信息导出

Type: GET

Author: 27951

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

Description: 信息导出

Query-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

id数组

false

-

name

string

姓名

false

-

company

string

单位名称

false

-

trade

string

所属行业

false

-

status

int32

状态:0删除 1进行中 2已关闭

false

-

reportingTime

string

创建时间

false

-

Request-example:

curl -X GET -i http://localhost:8888/reporting/informationReporting/download?ids=5ot7op&ids=5ot7op&status=273&reportingTime=2023-10-24 17:49:04&trade=8hf24l&company=洪-姚&name=梓晨.蔡

Response-example:

Doesn't return a value.

3. 账户管理模块

3.1. 管理员登录

Type: POST

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

Description: 管理员登录

Body-parameters:

ParameterTypeDescriptionRequiredSince

userName

string

用户名

true

-

password

string

密码

true

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:8888/reporting/user/login --data '{
  "userName": "梓晨.蔡",
  "password": "vrv572"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─id

int64

id

-

└─userName

string

用户名

-

└─name

string

管理员姓名

-

└─password

string

密码

-

└─adminType

int32

角色类别 1超级管理员、2管理员

-

└─time

string

创建时间

-

└─status

int32

状态(0停用 1正常)

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": {
    "id": 485,
    "userName": "梓晨.蔡",
    "name": "梓晨.蔡",
    "password": "2hv1yo",
    "adminType": 812,
    "time": "2023-10-24 17:49:04",
    "status": 329
  }
}

3.2. 添加管理员

Type: POST

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

Description: 添加管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

id

false

-

userName

string

用户名

true

-

name

string

管理员姓名

true

-

password

string

密码

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/add --data '{
  "id": 286,
  "userName": "梓晨.蔡",
  "name": "梓晨.蔡",
  "password": "mmhr9w"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "u0yx2x"
}

3.3. 删除管理员

Type: DELETE

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

Description: 删除管理员

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

id数组

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/delete --data '{
  "ids": [
    474
  ]
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "8ylnjz"
}

3.4. 修改管理员信息

Type: PUT

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

Description: 修改管理员信息

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

id

false

-

userName

string

用户名

true

-

name

string

管理员姓名

true

-

password

string

密码

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/update --data '{
  "id": 140,
  "userName": "梓晨.蔡",
  "name": "梓晨.蔡",
  "password": "5uak1k"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "dqplzm"
}

3.5. 修改本人密码

Type: PUT

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

Description: 修改本人密码

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

当前登录管理员id

true

-

password

string

原密码,密码使用公钥加密后传输

true

-

newPassword

string

新密码,密码使用公钥加密后传输

true

-

Request-example:

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'admin_token' -i http://localhost:8888/reporting/user/updatePassword --data '{
  "id": 814,
  "password": "7uxtmi",
  "newPassword": "dg93o9"
}'

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "fi13r5"
}

3.6. 管理员列表

Type: GET

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

Description: 管理员列表

Request-headers:

HeaderTypeDescriptionRequiredSince

admin_token

string

null

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

userName

string

用户名

false

-

name

string

管理员姓名

false

-

time

string

创建时间

false

-

currPage

int32

当前页,默认1

false

-

pageSize

int32

每页大小,默认10

false

-

orderField

string

排序字段,可选择值参考返回结果

false

-

order

string

排序方式,可选值:asc、desc

false

-

Request-example:

curl -X GET -H 'admin_token' -i http://localhost:8888/reporting/user/list?name=梓晨.蔡&order=s8xfr2&currPage=1&time=2023-10-24 17:49:04&orderField=4dt5vt&userName=梓晨.蔡&pageSize=10

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

└─totalCount

int32

总记录数

-

└─pageSize

int32

每页记录数

-

└─totalPage

int32

总页数

-

└─currPage

int32

当前页数

-

└─list

array

列表数据

-

     └─id

int64

id

-

     └─userName

string

用户名

-

     └─name

string

管理员姓名

-

     └─password

string

密码

-

     └─adminType

int32

角色类别 1超级管理员、2管理员

-

     └─time

string

创建时间

-

     └─status

int32

状态(0停用 1正常)

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": {
    "totalCount": 596,
    "pageSize": 10,
    "totalPage": 1,
    "currPage": 1,
    "list": [
      {
        "id": 500,
        "userName": "梓晨.蔡",
        "name": "梓晨.蔡",
        "password": "apb0ix",
        "adminType": 556,
        "time": "2023-10-24 17:49:04",
        "status": 938
      }
    ]
  }
}

4. 获取微信绑定手机号

4.1. 通过code换取用户手机号

Type: GET

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

Description: 通过code换取用户手机号

Query-parameters:

ParameterTypeDescriptionRequiredSince

code

string

No comments found.

false

-

state

string

No comments found.

false

-

Request-example:

curl -X GET -i http://localhost:8888/reporting/wx/getPhone?code=48406&state=8r9vmx

Response-fields:

FieldTypeDescriptionSince

success

boolean

接口调用结果标识

-

message

string

接口调用结果信息

-

code

string

接口调用业务码

-

data

object

接口调用返回数据

-

Response-example:

{
  "success": true,
  "message": "success",
  "code": "48406",
  "data": "y4lbtz"
}

4.2. 获取用户在微信中的openid

Type: GET

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

Description: 获取用户在微信中的openid

Query-parameters:

ParameterTypeDescriptionRequiredSince

code

string

用户授权后得到的code

false

-

Request-example:

curl -X GET -i http://localhost:8888/reporting/wx/getOpenId?code=48406

Response-example:

string