首页 > 其他分享 >用户模块接口文档

用户模块接口文档

时间:2024-11-15 19:56:46浏览次数:1  
标签:code 请求 模块接口 用户 响应 文档 参数 data String

一、用户注册

1、基本信息:

请求路径:/user/register
请求方式:POST
接口描述:该接口用于用户通过手机号注册账号

2、请求参数:
请求参数格式:applocation/json

参数名称 说明 类型 是否必须 备注
phone 手机号码 String 必须输入11位
password 登录密码 String 必须5-16位

3、请求样例:

{
  “phone”: "12345678901"
  “password”: “123456”
}

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据

响应数据样例:

{
    "code": 1,
    "massage": "该手机号已注册",
    "data": null
}
{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间: 19:11:30.229368700 来自于 MiniShopping "
}

二、用户登录

1、基本信息:

请求路径:/user/login
请求方式:POST
接口描述:该接口用于用户通过手机号登录账号

2、请求参数:
请求参数格式:applocation/json

参数名称 说明 类型 是否必须 备注
phone 手机号码 String 必须输入11位
password 登录密码 String 必须5-16位

3、请求样例:

{
  “phone”: "12345678901"
  “password”: “123456”
}

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据是JWT令牌,需要客户端保存该令牌,后续请求进行附带作为已登录标志同时验证身份 JWT令牌申请后一个小时自动过期

响应数据样例:

{
    "code": 1,
    "massage": "该手机号未注册",
    "data": null
}
{
    "code": 1,
    "massage": "密码错误",
    "data": null
}
{
    "code": 0,
    "massage": "操作成功",
    "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGFpbXMiOnsicGhvbmUiOiIxMjM0NTY3ODkwNyIsImlkIjo2fSwiZXhwIjoxNzMxNzEyNzIxfQ.suxQYM1Byw8p6WV7xCb-cbvkMcLYKw5EA2kO8gnMzlA"
}

三、获取用户基本信息

1、基本信息:

请求路径:/user/userInfo
请求方式:GET
接口描述:该接口用于用户获取基本信息

2、请求参数:无,但需要将登录时下发的JWT令牌附带于请求头header中,请求头名称为Authorization,值为JWT令牌

3、请求样例:无

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data Object 返回的数据

响应数据样例:

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "id": 2,
        "phone": "12345678903",
        "nickname": "",
        "gender": "",
        "user_pic": "",
        "address": "",
        "email": "",
        "create_time": "2024-11-15T01:53:47",
        "update_time": "2024-11-15T01:53:47"
    }
}

四、更新用户信息

1、基本信息:

请求路径:/user/update
请求方式:PUT
接口描述:该接口用于用户更新不重要信息(除了id,手机号,头像和密码)

2、请求参数:
请求参数格式:applocation/json

参数名称 说明 类型 是否必须 备注
id 主键ID number 用于验证身份,在该接口无法修改
phone 手机号 String 用于验证身份,在该接口无法修改
nickname 昵称 String
gender 性别 String
address 地址 String
email 邮箱 String 非空时需要满足电子邮箱格式

3、请求样例:

{
    "id": 2,
    "phone": "12345678901",
    "nickname": "",
    "gender": "男",
    "user_pic": "",
    "address": "",
    "email": ""
}

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据

响应数据样例:

{
    "code": 0,
    "massage": "操作成功",
    "data": "更新成功"
}

标签:code,请求,模块接口,用户,响应,文档,参数,data,String
From: https://www.cnblogs.com/xulingduo/p/18548540

相关文章

  • hbase-2.2.7分布式搭建文档(附详细操作步骤命令及相关操作截图)
    hbase-2.2.7分布式搭建文档一,搭建前准备1.检查是否已经安装JDK2.搭建hbase前需要先搭建好hadoop3.检查zookeeper是否正常启动#启动zookeeper(三台都要启动)zkServer.shstart#查看zookeeper状态(一个leader两个follower)zkServer.shstatus4.到官网或国内镜像站下载hba......
  • 列表数据隔离--采购申请单只能看当前用户的单据信息 过滤,PrepareFilterParameter 2
    region<<版本注释>>/*===================================================类名称:PUR_Requisition_listFilter类描述:列表数据隔离--采购申请单只能看当前用户的单据信息过滤,PrepareFilterParameter创建人:luohong创建时间:2024/11/1516:18:04电子邮箱:it_lu......
  • pdf.js使用gulp打包,查看打包后的文档
    在pdf.js的源码中,使用了gulp进行打包,现在对部分有用的gulp方法进行说明gulpserver运行一个服务器版本,能够对源码进行调试gulpgeneric打包一个通用浏览器版本的代码,运行命令后在build/generic/web/viewer.html可以直接打开运行web程序gulpwintersmith是生成gh-pages,用来......
  • AI概要设计文档评审实践
    背景概要设计文档评审是软件开发过程中的一个重要环节,主要体现在以下几个方面:1.确保设计的一致性和完整性:通过评审,可以确保设计文档中描述的系统架构、模块划分、接口定义等内容在各个部分之间保持一致,避免出现相互矛盾或遗漏的情况。评审过程有助于发现设计中的潜在问题,如数据流......
  • SSM理想电子商城网站c48j7 带论文文档1万字以上,文末可获取
    本系统(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。系统程序文件列表系统内容:用户,产品分类,电子产品开题报告内容一、选题背景与意义随着互联网技术的快速发展和电子商务的兴起,电子商城已成为人们购物的主要方式之一。然而,传统......
  • SQL Server数据库添加只读用户
    需求描述笔者手头有一个已经部署好的SQLServer数据库,现需要给外部人员开通访问权限,但又要避免外部人员误操作污染数据库,所以这里选择给他们配置数据库只读用户。详细配置步骤我们打开MicrosoftSQLServerManagementStudio(简称SSMS),连接对应数据库引擎,如下图菜单位置,右键点......
  • 《Java核心技术 卷I》用户图形界面鼠标事件
    鼠标事件        如果只希望用户能够点击按钮或菜单,那么就不需要显式地处理鼠标事件,鼠标操作将由用户界面中的各种组件内部处理,不过,如果希望用户能使用鼠标画图,就需要捕获鼠标移动,点击和拖动事件。本节,我们将展示一个简单的图形编辑器应用,它允许用户在画布上放置、移......
  • Oracle用户管理模式下的备份恢复
    Oracle用户管理模式下的备份恢复1、用户管理模式下的冷备份1.1查询数据库相关信息查实例selectinstance_name,version,status,archiver,database_statusfromv$instance;查数据库selectdbid,name,log_modefromv$database;查数据文件状态selectfile_name,tabl......
  • 基于Java+SpringBoot+Vue+HTML5电影订票系统(源码+LW+调试文档+讲解等)/电影订票/电影
    博主介绍......
  • 基于Java+SpringBoot+Vue+HTML5课程设计选题管理(源码+LW+调试文档+讲解等)/课程设计/
    博主介绍......