美文网首页
帮帮找接口文档 v1.0

帮帮找接口文档 v1.0

作者: 杨胜超 | 来源:发表于2016-12-17 11:48 被阅读133次

[Toc]

帮帮找接口文档 v1.0

附录

1.错误描述errorCode

错误码 类型 说明
1200 int 操作成功
1500 int 操作失败

2.图片上传

  • 简要概述
    所有图片均以此接口进行上传,以流进行传输.
    上传后将图片地址返回.

  • 参数

参数名 必选 类型 说明
image 是 string 图片名
  • 返回
参数名 必选 类型 说明
url 是 string 图片地址

3.其他

  • 所有列表项均有pageNo字段(页数).请自行添加,以下接口不再对此字段做描述.

一.登录注册

1.0 注册接口

请求URL：

  • /interface/user/register

参数：

参数名 必选 类型 说明
phone 是 string 手机号码
password type=2 string 登录密码
openId type!=2 string 微信/qq唯一标识号
headImage type!=2 string QQ微信头像地址
nickname type!=2 string QQ微信昵称
type 是 sting 0:微信登录 1 QQ登录 2 手机号登录

返回示例

 {
   "errorCode" : "1200",
   "msg" : "操作成功", 
   "data" : {
     "headImage":"",
     "idcard":"", 
     "name":"", 
    "phone":"12345678000", 
    "userId":"18", 
    "userType":""
   }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型，雇主，施工单位，工人
headImage string 头像地址
name string 用户名
phone string 手机号
idcard string 身份证号码

1.1 登录接口

登录

简要描述：

  • 用户可通过微信登录/QQ登录/手机号登录

若用户通过微信/QQ登录，系统可自动注册.
若用户通过手机号登录，需要验证是否存在，存在则登录，否则注册。

请求URL：

  • /interface/user/login

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
phone type=2 string 手机号码
password type=2 string 登录密码
openId type!=2 string 微信/qq唯一标识号
headImage type!=2 string QQ微信头像地址
nickname type!=2 string QQ微信昵称
type 是 sting 0:微信登录 1 QQ登录 2 手机号登录

返回示例

 {
   "errorCode" : "1200",
   "msg" : "操作成功", 
   "data" : {
     "headImage":"",
     "idcard":"", 
     "name":"", 
    "phone":"12345678000", 
    "userId":"18", 
    "userType":""
   }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型，雇主，施工单位，工人
headImage string 头像地址
name string 用户名
phone string 手机号
idcard string 身份证号码

1.2 找回密码/修改密码

注：前端使用验证码校验
简要描述：

  • 用户登录接口

请求URL：

  • /interface/user/getPass

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
phoneNumber 是 string 用户名
password 是 string 新密码

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "headImage":"",
    "idcard":"",
    "name":"",
    "phone":"12345678000",
    "userId":"18",
    "userType":""
  }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型，雇主，施工单位，工人
headImage string 头像地址
name string 用户名
phone string 手机号

1.3 完善个人信息(实名认证)

简要描述：

  • 用户实名认证,所有用户必须通过实名认证后才可使用app功能.

请求URL：

  • /interface/user/aotonmy

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户ID
headImage 是 string 头像
name 是 string 姓名
sex 是 string 性别
birthday 是 date 生日
idcard 是 string 身份证号
address 是 string 地址

返回示例

 {
  "errorCode":"1200", 
  "msg":"操作成功"
}

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败

1.4 审核成为工人

简要描述：

  • 用户实名认证后，可审核成为工人.

请求URL：

  • /interface/user/checkWorker

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户ID
idCardF 是 string 身份证正面
idCardB 是 string 身份证反面
idCardH 是 string 手持身份证
workType 是 String 工种
experience 是 string 经验
speciality 是 string 特长
certificate 是 string 证书
descript 是 string 自我描述

返回示例

无

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败
status string 0 :未审核 1: 通过 2:未通过
createUser string 审核人
checkTime string 审核时间
cause string 未通过原因(根据具体情况显示)

1.5 审核成为施工单位/材料厂商

简要描述：

  • 用户实名认证后，可审核成为施工单位/材料厂商.

请求URL：

  • /interface/user/checkUnit

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户ID
comLogo 是 string 公司logo
comName 是 string 公司名称
workAddr 是 string 办公地址
telephone 是 String 座机
certificate 是 string 营业执照
picture 是 string 图片
information 是 string 其他信息

返回示例

无

返回参数说明

参数名 类型 说明
code string 1:成功 0 :失败
status string 0 :未审核 1: 通过 2:未通过
createUser string 审核人
checkTime string 审核时间
cause string 未通过原因(根据具体情况显示)

注：工人列表/详情，职位列表/详情，请求URL：

  • /interface/demand/demandList

二.找工人

2.1 工人列表

工人列表
简要描述：
  • 附近的工人列表

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
longitude 是 string 经度
latitude 是 string 纬度

返回示例

  无

返回参数说明

参数名 类型 说明
id string 工人id
name string 工人姓名
workType string 工人
speciality string 擅长
rank string 星级
longitude string 经度
latitude string 纬度

2.2 工人详情

工人详情
简要描述：
  • 工人详情

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
workerId 是 string 工人id
longitude 是 string 经度
latitude 是 string 纬度

返回示例

  无

返回参数说明

  • 自行参考设计稿中所有字段
  • isCollection 是否收藏（/interface/user/isCollection）
  • 工人评价信息（/interface/demand/wokerCommentList）

2.2.1 收藏/取消收藏工人

简要描述：

  • 附近的工人列表

请求URL：

  • /interface/user/addCollection
  • /interface/user/deleteCollection

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
workerId 是 string 工人id
type 是 string 1:收藏 0 取消收藏

返回示例

  无

返回参数说明

  • 返回成功/失败即可

2.2.2 雇佣该工人（没写呢）

参数：

参数名 必选 类型 说明
userId 是 string 用户id
workerId 是 string 工人id
detail 是 string 备注信息

返回:

  • 返回成功或者失败即可.

2.3 发布求职

简要描述：

  • 发布求职

请求URL：

  • /interface/work/applyJob

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
workerId 是 string 工人id
exAddr 是 string 期望工作地点
exSalary 是 string 期望薪水
remark 是 string 备注
entryTime 是 string 入职时间

返回示例

  无

返回参数说明

参数名 类型 说明
name string 工人姓名
age string 出生年月（处理成年龄）
sex string 性别
rank string 星级
address string 住址
workType int 工种
speciality string 擅长
descript string 自我描述
exAddr string 期望工作地点
exSalary string 期望薪资
remark string 备注
entryTime string 入职时间

三.找工作

3.1职位列表

职位列表
简要描述：
  • 职位列表

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
longitude 是 string 经度
latitude 是 string 纬度

返回示例

  无

返回参数说明

参数名 类型 说明
id string 工作id
name string 发布者
time long 发布时间(时间戳)
projectName String 项目名
period string XX年XX月XX日到XX年XX月XX日
workAddr string 工作地点
remark string 备注
needList list 所需工种

其中needList内字段主要为:（单独接口）

请求URL：

  • /interface/demand/needList
参数名 类型 说明
workType int 工种id
personNum int 当前工种人数
salaryType int 薪资类型
salary double 薪资

3.1.1 申请加入（没写呢）

参数：

参数名 必选 类型 说明
userId 是 string 用户id
workId 是 string 职位id
detail 是 string 备注信息

返回:

  • 返回成功或者失败即可.

3.2 发布职位

请求URL：

  • /interface/work/recruit

参数：

参数名 必选 类型 说明
projectName 是 string 项目名称
period 是 string 项目周期（起止时间 xxxx年xx月xx日至xxxx年xx月xx日）
workAddr 是 string 工作地点
remark 是 string 备注信息
needList 是 string 需求列表

其中needList内字段主要为:

参数名 类型 说明
workType int 工种id
personNum int 需求人数
salaryType int 薪资类型 1 日薪 2 月薪 3 年薪
salary double 薪资

返回:

  • 返回成功或者失败即可.

四.找材料（没写）

4.1 采购清单列表

采购清单列表

简要描述：

  • 采购清单列表

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
type 是 string 1:已提交的清单 0:未提交清单

返回示例

  无

返回参数说明

参数名 类型 说明
inventoryId string 清单id
inventoryName string 清单名称
inventoryDetail List 清单内所含商品

其中inventoryDetail内含字段为:

参数名 类型 说明
goodId string 商品名
goodNum string 数量
goodImage string 商品图片
goodState string 商品状态:(1已收到x家商家报价,2已选择某某商家)
marchantPrice string 已选中的商家报价金额

4.2 清单详细信息

清单详细信息
简要描述：
  • 清单详细信息

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
purchasingId 是 string 清单Id

返回示例

  无

返回参数说明

参数名 类型 说明
inventoryId string 清单id
inventoryName string 清单名称
inventoryDetail List 清单内所含商品

其中inventoryDetail内含字段为:

参数名 类型 说明
goodId string 商品名
merchantName string 商家名称
goodNum string 数量
goodImage string 商品图片
goodState string 商品状态:(1已收到x家商家报价,2已选择某某商家)
marchantPrice string 已选中的商家报价金额

4.3 生成订单

4.4 发布清单

五.交流大厅

5.1 大厅列表

大厅列表
简要描述：
  • 交流大厅,排序优先将附近的排在最前面,不含评论

请求URL：

  • /interface/exchange/exchangeList

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户id
longitude 是 string 经度
latitude 是 string 纬度

返回参数说明

参数名 类型 说明
id string 用户id
icon string 用户头像
name string 用户姓名
time string 发布时间 时间戳
longitude string 经度
latitude string 纬度
content string 用户发的内容
image string 图片地址,多张图片以逗号隔开

5.1.1 交流详情

简要描述：

  • 动态的具体信息，含该动态所有评论信息

请求URL：

  • /interface/exchange/exchangeDetail

参数：

参数名 必选 类型 说明
communityId 是 string 条目id

返回参数说明

  • 主要返回的是评论数据
参数名 类型 说明
id string 评论条目id
userId string 评论者id
name string 用户姓名
time string 发布时间 时间戳
word string 评论内容

5.1.2 发表评论

请求URL：

  • /interface/exchange/addComment

参数：

参数名 必选 类型 说明
userId 是 string 用户id
communityId 是 string 状态id
content 是 string 内容
picture 是 string 图片

返回参数说明

  • 返回成功/失败

5.2 发布状态

请求URL：

  • /interface/exchange/addCommunity

参数：

参数名 必选 类型 说明
userId 是 string 用户id
longitude 是 string 经度
latitude 是 string 纬度
content 是 string 内容
image 是 string 图片地址,多张图片以逗号隔开

返回参数说明

  • 返回成功/失败

六.个人中心

6.1 个人信息

简要描述：

  • 用户登录接口

请求URL：

  • /interface/user/userInfo

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户ID

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "headImage":"",
    "idcard":"",
    "name":"",
    "phone":"12345678000",
    "nickname":"",
    "sex":"",
    "birthday":"",
    "userId":"18",
    "userType":""
  }
}

返回参数说明

参数名 类型 说明
userId string 用户id
userType string 用户类型，雇主，施工单位，工人
headImage string 头像地址
name string 用户名
phone string 手机号
nickname string 用户昵称
sex string 性别
birthday string 出生年月
idcard string 身份证号
address string 地址

6.2 我的钱包

6.3 我的收藏

简要描述：

  • 用户登录接口

请求URL：

  • /interface/user/userCollectionList

请求方式：

  • POST ／GET

参数：

参数名 必选 类型 说明
userId 是 string 用户ID

返回示例

{
  "errorCode":"1200",
  "msg":"操作成功",
  "data":{    
    "collectionId":"",
    "title":"",
    "createTime":"",
    "tableId":"18",
    "tableName":""
  }
}

返回参数说明

参数名 类型 说明
collectionId string 收藏id
title string 简要描述
createTime string 收藏时间
tableId string 被收藏人id
tableName string 被收藏人姓名

6.4 我的合同

6.5 我的订单

6.6 认证与审核

七.消息中心

相关文章

  • 帮帮找接口文档 v1.0

    [Toc] 帮帮找接口文档 v1.0 附录 1.错误描述errorCode 2.图片上传 简要概述所有图片均以此接...

  • 使用swagger优雅书写api文档

    书写和前端对接的api文档十分痛苦，工作中经常会有下面场景 接口文档地址分散 接口文档相对代码更新滞后 前端同事找...

  • 2018-09-28

    该文档提供了找罐车与找油网TMS系统对接需要用到的接口，主要包括demand、carrier order相关接口。...

  • 产品设计&团队协作流程

    产品设计&团队协作说明 文档密级：内部 文档编号：CP-10-2016 文档版本：v1.0 文档状态：发布 发布日...

  • Vue应用框架整合与实战--前后端分离后的开发模式篇

    开发流程 后台编写和维护接口文档，在 API 变化时更新接口文档 后台根据接口文档进行接口开发 前端根据接口文档进...

  • 接码平台汇总

    短租接口文档 火云接口文档 火云官网 神话接口文档

  • git 根据tag创建分支

    example 会以tag v1.0创建新的分支newbranch 原文档地址

  • 接口测试--接口文档规范

    接口测试的依据，往往不是需求文档，而是接口文档。 那么，接口文档的准确性便至关重要，本文推荐apipost接口文档...

  • 帮帮产品需求文档

    根据自己设计的原型所编写的需求文档，新手上路多多指教~原型：https://6juh80.axshare.com/...

  • rook 安装ceph

    //参考文档https://rook.io/docs/rook/v1.0/ceph-examples.html 下...

网友评论

      本文标题：帮帮找接口文档 v1.0

      本文链接：https://www.haomeiwen.com/subject/juvomttx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|帮帮找接口文档 v1.0|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！