美文网首页
API文档模板

API文档模板

作者: 楚谜 | 来源:发表于2016-05-17 10:57 被阅读0次

用户信息接口列表


读取接口

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

相关文章

  • API文档模板

    用户信息接口列表 读取接口 写入接口 用户信息接口详情 users/mobile 获取用户手机号 是否需要权限验证...

  • 《模板》API说明文档

    查询区块列表 接口功能 获取系统中已录入的所有区块及描述 URL GET /admin/block 响应格式 JS...

  • mpvue使用云函数生成小程序码

    创建云开发模板 官方api文档配置云调用权限 创建getUnlimited云函数目录结构 1.getUnlimit...

  • 个人微信开发api

    个人微信开发api,微信开发api文档,微信api接口文档 case "HeartBeatReq": {// 客户...

  • swagger

    介绍 号称世界上最流行的APi框架; restful Api文档在线自动生成工具 ->APi文档与Api定义同步更...

  • VC多文档程序文档,视图指针遍历问题

    2009-05-11 1、模板、文档、视图、框架的关系 (1)文档保留该文档的视图列表和指向创建该文档的文档模板的...

  • 开发者文档

    瑞雪开发者文档 瑞雪开发文档 目录: 用户系统: 登录API 注册API 获取用户信息API 修改用户信息API ...

  • 开始 - Get Start

    基本 HTML 文档 基于 Bootstrap 的文档模板

  • API 文档

    1、gulp.src(globs[, options]) 输出(Emits)符合所提供的匹配模式(glob)或匹配...

  • API文档

    Dash是一个API文档浏览器( API Documentation Browser),以及代码片段管理工具(Co...

网友评论

      本文标题:API文档模板

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