RESTful风格API接⼝⽂档模板
1 接⼝名称
⽤户注册接⼝
2 接⼝描述
1. ⽤户信息注册
2. ⽤户可以通过 ⼿机号/邮箱 进⾏注册
3. 同⼀个 ⼿机号/邮箱只能注册⼀个账号
3 请求地址
{apiAddress}/api/user/signup
4 请求⽅式
POST
5 请求参数
5.1 Header 参数
参数名必选类型/参数值说明Content-Type是application/json请求参数类型5.2 Body 参数
参数名必选类型限制条件说明⽰例值account是string 1 < length < 50⽤户账号
passcode是string 1 < length < 50密码
checkCode是string length = 6验证码
注意事项: 密码(passcode) 的加密⽅式为 xxxxxx
需要调⽤到的其他接⼝:
接⼝名称接⼝地址⽤途说明
获取验证码{apiAddress}/api/common/getCheckCode获取注册所需验证码5.3 请求⽰例
{
"account":1001,
"passcode":123456,
"checkCode":1
}
6 响应参数
6.1 返回参数
参数名必选类型限制条件说明⽰例值account是string 1 < length < 50⽤户账号
passcode是string 1 < length < 50密码
checkCode是string length = 6验证码
6.2 返回⽰例
{
"code":200,// 状态码
"msg":"成功",// 提⽰信息
"data":null// 返回内容
}
7 备注
更多返回错误码请查看⾸页返回状态码表
8 错误响应码(选⽤)百度api接口
错误码错误描述原因解决⽅案⽰例值SYSTEMERROR接⼝返回错误系统超时请使⽤相同 参数再次调⽤ API。001
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论