美文网首页
接口文档

接口文档

作者: DoEmpty | 来源:发表于2019-03-10 21:22 被阅读2次

接口列表

接口 说明
获取微信OpenID 进入小程序,进行静默登录,使用微信内部的code通过开发服务器换取openID
个人信息 用户进入小程序,根据微信OpenID获取对应的账户信息
基础信息 职位、单位、专业等基础数据获取
用户激活 首次进入小程序,输入必要信息,激活账号
公告列表 返回后台发布的公告信息
讨论中建议列表 讨论中TAB整改列表获取 共用同一个接口
待整改建议列表 待整改TAB整改列表获取 共用同一个接口
已整改建议列表 已整改TAB整改列表获取 共用同一个接口
建议明细 列表页面中点击单条建议进入的明细页面展现的建议详情
讨论 建议明细页面,对建议发起的评论提交
附件上传 讨论过程中用户提交的附件 或 用户上传的头像

报文格式

请求响应采用统一的报文格式,包括header,body两部分,header中包括业务码、提示信息等;body中包括具体的业务参数。
以下描述的报文参数数据类型为参数真实的数据类型,但交互过程中统一使用字符串类型传输
采用httpcode判断接口请求是否发生异常(仅当200为正常)。
业务码判断本次请求的业务结果,业务码类型为string,参见下表

请求体 说明
0000 请求正确,达成预定目标
1000 参数缺失或类型错误
2000 逻辑校验失败
……
请求报文示例:
{
  header:{
  },
  body:{
    wxOpenID:"",
    departID:1,
    mobile:""
  }
}
响应报文示例:
{
  header:{
    code:"0000",
    wxOpenID:"",
    message:"注册成功",
  },
  body:{
    departID:1,
    mobile:"",
    name:""
  }
}

接口详情

1.以下描述的接口参数均为body中的参数
2.所有提交给服务器的附件只是完整的文件名(包括后缀),服务器响应的附件为完整的URL地址

0.获取微信OpenID

微信小程序段获取OpenID需要通过小程序拿到的Code去开发服务器兑换,涉及到签名,解密,与微信服务器交互等问题,请参照

  • 接口地址:

  • 请求方式:POST

  • 请求参数说明:

名称 类型 必填 说明
code string true 微信内部code
  • 返回参数说明:
名称 类型 必填 说明
wxOpenID string true 微信openID

1.个人信息

  • 接口地址:

  • 请求方式:GET

  • 请求参数说明:

名称 类型 必填 说明
wxOpenID string true 微信OpenID
  • 返回参数说明:
名称 类型 必填 说明
ID int true 用户在本系统中对应的ID
wxOpenID string true 微信OpenID
name string true 用户姓名
cardID string true 用户身份证号,中间关键部分用*代替
phoneNo string true 用户手机号码,中间四位*代替
departID int true 部门ID
positionID int true 职位ID
professionID int true 专业ID
activeTime datetime true 激活时间
announcements array false 个人中心页需要显示公告,相关参数请参照公告列表接口

2.基础数据获取

  • 接口地址:

  • 请求方式:GET

  • 请求参数说明:

名称 类型 必填 说明
dataType string true 请求的数据类型:depart/position/profession
  • 返回参数说明:
名称 类型 必填 说明
id int true 数据ID
name string true 数据名称

3.用户激活

  • 接口地址:

  • 请求方式:POST

  • 请求参数说明:

名称 类型 必填 说明
wxOpenID string true 微信OpenID
departID int true 部门ID
professionID int true 专业ID
name string true 姓名
phoneNo string true 电话号码
cardID string true 身份证号
  • 返回参数说明:
名称 类型 必填 说明
参照个人信息接口

4.公告列表

  • 接口地址:

  • 请求方式:GET

  • 请求参数说明:

名称 类型 必填 说明
pageIndex int true 当前页索引(从1开始)
pageSize int true 页显示总条数
  • 返回参数说明:
名称 类型 必填 说明
title string true 公告标题
content string true 内容

5.建议列表

  • 接口地址:

  • 请求方式:GET

  • 请求参数说明:

名称 类型 必填 说明
pageIndex int true 当前页索引(从0开始)
pageSize int true 页显示总条数
wxOpenID string true 微信OpenID
type int true 类别:0=讨论中,1=待整改,2=已整改
  • 返回参数说明:
名称 类型 必填 说明
id int true 建议ID
serialNo string true 建议业务号
title string true 建议标题
type int true 建议类型:1、措施;2、主意;3、问题
presentSituation string true 现状描述
effect string true 效果预测
problem string true 存在问题
solution string true 解决方案
examStatus int true 审核状态:0未审核,1通过初审,2初审退回,3通过中审,4中审退回,5通过终审,6终审退回
userID int true 提出人ID
userName string true 提出人姓名
createTime datetime true 提出时间
comments array false 讨论列表

comments 参数明细:

名称 类型 必填 说明
id int true 建议ID
content string true 评论内容
createTime datetime true 评论时间
userID int true 评论人ID
userName string true 评论人姓名

6.建议明细

  • 接口地址:

  • 请求方式:GET

  • 请求参数说明:

名称 类型 必填 说明
wxOpenID string true 微信OpenID
id int true 建议ID
  • 返回参数说明:
名称 类型 必填 说明
id int true 建议ID
serialNo string true 建议业务号
title string true 建议标题
type int true 建议类型:1、措施;2、主意;3、问题
presentSituation string true 现状描述
effect string true 效果预测
problem string true 存在问题
solution string true 解决方案
isQualified int true 是否合格:1 合格,0 不合格
examOpinion string false 审查意见
examStatus int true 审核状态:0未审核,1通过初审,2初审退回,3通过中审,4中审退回,5通过终审,6终审退回
rectifyStatus int true 整改状态:0未整改,1已整改,2无法整改
preOpinion string false 初评意见
preScore int false 初评分数
preExamer string false 初评人
midOpinion string false 中评意见
midScore int false 中评分数
midExamer string false 中评人
proOpinion string false 终评意见
proScore int false 终评分数
proExamer string false 终评人
userID int true 提出人ID
userName string true 提出人姓名
departID int true 提出部门
professionID int true 提出专业
positionID int true 提出职位
createTime datetime true 提出时间
comments array false 讨论列表,见建议列表接口
attachments array false 附件:附件名数组

comments 参数明细:

名称 类型 必填 说明
id int true 建议ID
content string true 评论内容
createTime datetime true 评论时间
userID int true 评论人ID
userName string true 评论人姓名
attachments array false 附件:附件名数组

7.提交评论

  • 接口地址:

  • 请求方式:POST

  • 请求参数说明:

名称 类型 必填 说明
wxOpenID string true 微信OpenID
suggestID int true 建议ID
content string true 评论内容
attachments array false 附件:附件名数组
  • 返回参数说明:
名称 类型 必填 说明

8.附件上传

该接口用于同微信服务器做对接,接收微信服务器中转发送过来的文件。
具体请参照微信上传附件
object.success 回调函数参数说明

名称 类型 必填 说明
data string true 附件名

相关文章

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

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

  • 接码平台汇总

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

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

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

  • 谈谈单接口测试

    如果只是单个接口的测试还是归属于功能测试。 平时我们是怎么做接口测试的?接口文档、接口文档,一定要看接口文档。初学...

  • 工作总结 文章目录

    工作总结 文章目录 狼人杀拾旧后台接口文档 狼人杀俱乐部后台接口文档 狼人杀接口文档 OA使用文档(报表,人事) ...

  • drf框架接口文档

    drf框架接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接...

  • 接口文档工具 apiPost

    ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。 生成Mock...

  • 接口文档

    接口文档 1.登录 请求地址:/account/login请求方式:post 成功示例:{"ok":1,"data...

  • 接口文档

    第6节(判断数据库中是否有此用户) post www.test.com/api api.test.com

  • 接口文档

    1.获取铁甲云盒项目实时视频的API链接 接口地址: http:xxx:9998/tools/app_api.as...

网友评论

      本文标题:接口文档

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