API文档模板

用户信息接口列表


读取接口

users/mobile 获取用户手机号

写入接口

users/mobile/put 上传用户手机号

用户信息接口详情

  • users/mobile


获取用户手机号

是否需要权限验证

请求参数

| | 必选 | 类型 | 说明 |
|:-------------:|:-------------|:-------------|
| userId | true | int | 用户ID |

请求方法

GET

调用样例

`` users/mobile?userId=214 ``

返回结果

*** JSON示例 ***

` ``

{

"code": 0,

"msg": "",

"data": {

"mobile": 150888888888

}

}

` ``

*** 错误返回值 ***

| code | msg | 说明 |
|:-------------:|:-------------|
| 1010 | xxxx | xxxx |

关于其它错误返回值与错误代码,参见 错误代码说明

ErrorCode

错误代码对照表


系统级错误

| 错误代码 | 返回msg | 详细描述 |
|:-------------:|:-------------|
| 400 | 系统错误,请稍候再试 | 请求参数有误 |
| 401 | 系统错误,请稍候再试 | 用户未登录 |
| 404 | 系统错误,请稍候再试 | 资源未找到 |
| 405 | 系统错误,请稍候再试 | 请求方法不支持 |
| 500 | 系统错误,请稍候再试 | 服务器错误 |

业务级错误

错误代码 详细描述
1010 xxxx
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,923评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,251评论 25 708
  • iOS网络架构讨论梳理整理中。。。 其实如果没有APIManager这一层是没法使用delegate的,毕竟多个单...
    yhtang阅读 5,252评论 1 23
  • error code(错误代码)=0是操作成功完成。error code(错误代码)=1是功能错误。error c...
    Heikki_阅读 3,452评论 1 9
  • 22天复盘参考思路: 【目标与实现】 最初,我进营的目标是【我的22天的目标】: 001 学会记笔记。 002 看...
    卓_Rain阅读 232评论 1 2