接口文档格式

原创 2018年04月17日 17:59:55

全局说明

基础参数 header (无特殊说明都需要传入)

token       验证信息(过期周期1天,根据换班时间来更新)
deviceId    设备号
version     版本号

默认参数

返回的boolean类型的值若无特别说明都以str类型返回(‘0’false,’1‘ true)

参数格式

Header上传参数格式(登录、工厂配置接口不需要)

返回参数格式

{
    success:boolean, [状态码true:成功,false:失败]
    errorCode: str, ["10001":成功,"10000":失败]
    msg: str,[信息]
    data:object  [业务数据 在具体接口中只列出data中的数据格式]
}

密码登录

POST user/login(不需要token,需要把deviceId传入)

* 入参 *

userName:str //用户名 
password:str //密码,需要MD5

* 数据返回 *

{
  "token":str, //验证签名
  "userRole"int //(1,角色1;2,角色2;3,角色3)
  "account":str//账号
  "name":str //昵称
  ……
}
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/sunyejia/article/details/79978462

Excel条件格式实战视频课程【你学得会】

-
  • 1970年01月01日 08:00

服务器接口文档详细 接口文档模板 规范 完整

完整接口文档见http://download.csdn.net/download/qq_36467463/10214090
  • qq_36467463
  • qq_36467463
  • 2018-01-19 14:31:02
  • 346

接口模板 接口文档

  • 2016年05月20日 16:54
  • 26KB
  • 下载

用markdown编辑器写技术接口文档

一直想找一套开源程序来写接口文档,看过showdoc,swagger之类的,感觉都不是很方便 ,后来发现还是用markdown写技术接口文档比较方便! 写md文件推荐使用gitbook 下载地址 ht...
  • liangpz521
  • liangpz521
  • 2017-01-05 17:49:38
  • 2556

接口说明文档书写格式

1、根据企业唯一标识查找该企业下属企业信息: 方法:GET 接口url:rest-spring/kc/seldept/{企业唯一标识}.do 输出参数: 参数 参数名称 参数类型 ...
  • qq_38559500
  • qq_38559500
  • 2017-07-03 11:34:49
  • 99

android 开发 ------- 接口文档 规范

1 接口书写的格式: 1   用例图 2   流程图 3   具体的接口: 3.1请求的方式: 包括:   服务器地址 le.gxjinan.com/ope...
  • love_Javc_you
  • love_Javc_you
  • 2014-11-04 19:59:47
  • 8186

java接口文档规范

  • 2017年06月01日 10:55
  • 1KB
  • 下载

http接口文档

  • 2015年10月21日 16:24
  • 27KB
  • 下载

接口文档要如何写

一个简单的接口文档,写完给组长看后,发现漏洞百出。下面总结一下写文档需要注意事项: 封皮 封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期。(错误地方在于,文档的标题要...
  • lovesummerforever
  • lovesummerforever
  • 2015-04-21 14:36:11
  • 50321

接口文档的编写

作者:塔克拉玛干平原 链接:https://www.zhihu.com/question/52409287/answer/130390641 来源:知乎 著作权归作者所有。商业转载请联系作者获得...
  • chenluyao_it
  • chenluyao_it
  • 2017-12-19 10:18:51
  • 711
收藏助手
不良信息举报
您举报文章:接口文档格式
举报原因:
原因补充:

(最多只允许输入30个字)