Kevin's blog Kevin's blog
首页
  • Java基础
  • Java高级
  • MySQL
  • JDBC
  • Java 8新特性
  • 原生Servlet
  • 延迟队列
  • 分布式事务
  • ActiveMQ
  • Elasticsearch
  • Stream API
  • Redis 实战(黑马程序员)
  • Redis 课程(尚硅谷)
  • Redis数据类型和常用命令
  • 版本控制
  • Spring Framework
  • Spring MVC Framework
  • MyBatis Framework
  • MyBatis Plus Framework
  • Spring Boot Framework
  • 韩顺平 Spring Boot Framework
  • 在线教育
  • 谷粒商城 - 分布式基础 高级 集群
  • 谷粒商城 - 详细开发文档
  • docker基础
  • docker-compose容器编排
  • docker swarm集群管理
  • Vue2基础
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《JavaScript高级程序设计》
    • 《ES6 教程》
    • 《Vue》
    • 《React》
    • 《TypeScript 从零实现 axios》
    • 《Git》
    • TypeScript
    • JS设计模式总结
  • HTML
  • CSS
  • 技术文档
  • GitHub技巧
  • Nodejs
  • 博客搭建
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
关于
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)

Kevin

Java系统笔记
首页
  • Java基础
  • Java高级
  • MySQL
  • JDBC
  • Java 8新特性
  • 原生Servlet
  • 延迟队列
  • 分布式事务
  • ActiveMQ
  • Elasticsearch
  • Stream API
  • Redis 实战(黑马程序员)
  • Redis 课程(尚硅谷)
  • Redis数据类型和常用命令
  • 版本控制
  • Spring Framework
  • Spring MVC Framework
  • MyBatis Framework
  • MyBatis Plus Framework
  • Spring Boot Framework
  • 韩顺平 Spring Boot Framework
  • 在线教育
  • 谷粒商城 - 分布式基础 高级 集群
  • 谷粒商城 - 详细开发文档
  • docker基础
  • docker-compose容器编排
  • docker swarm集群管理
  • Vue2基础
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《JavaScript高级程序设计》
    • 《ES6 教程》
    • 《Vue》
    • 《React》
    • 《TypeScript 从零实现 axios》
    • 《Git》
    • TypeScript
    • JS设计模式总结
  • HTML
  • CSS
  • 技术文档
  • GitHub技巧
  • Nodejs
  • 博客搭建
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
关于
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)
  • 项目 在线教育

  • 项目 谷粒商城

  • 项目 谷粒商城详细开发文档

    • nacos、gateway、sentinel、sleuth
    • 环境搭建、域名、CORS、OSS
    • 规格参数及商品新增
    • 本地事务、分布式事务及seata
    • elasticsearch
    • 商品搜索
    • 模板引擎-Thymeleaf
    • rabbitmq
    • 首页商品分类
    • 商品详情页
    • 单点登录(jwt)
    • 购物车、SpringTask
    • 订单、库存
    • 支付、秒杀
    • 资料

      • 后台管理系统接口文档
      • 前端商城接口文档
        • 1. 获取某个菜单的子菜单
        • 2. 数据校验
        • 3. 生成短信验证码
        • 4. 用户注册
        • 5. 根据用户名和密码查询用户
  • Project
  • 项目 谷粒商城详细开发文档
  • 资料
zhihuanwang
2024-04-08
目录

前端商城接口文档

# 1. 获取某个菜单的子菜单

请求地址:/index/cates/{pid}

请求方式:GET

请求参数:

请求参数名 参数说明 值类型 是否必须
pid 分类的父id int 是

正确响应:

{
"code": 0,
"msg": "success",
"data": [
        {
            "catId": 100,
            "name": "文学",
            "parentCid": 1,
            "catLevel": 2,
            "showStatus": 1,
            "sort": 0,
            "icon": null,
            "productUnit": null,
            "productCount": 0,
            "subs": [
                {
                    "catId": 120,
                    "name": "小说",
                    "parentCid": 100,
                    "catLevel": 1,
                    "showStatus": 1,
                    "sort": 0,
                    "icon": null,
                    "productUnit": null,
                    "productCount": 0
                }
            ]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 2. 数据校验

功能说明:

实现用户数据的校验,主要包括对:手机号、用户名的唯一性校验。

接口路径:

GET /ums/user/check/{data}/{type}
1

参数说明:

参数 说明 是否必须 数据类型 默认值
data 要校验的数据 是 String 无
type 要校验的数据类型:1,用户名;2,手机;3,邮箱 是 Integer 无

返回结果:

返回布尔类型结果:

  • true:可用
  • false:不可用

# 3. 生成短信验证码

功能说明:

根据用户输入的手机号,生成随机验证码,长度为6位,纯数字。并且调用短信服务,发送验证码到用户手机。

接口路径:

POST /ums/user/code
1

参数说明:

参数 说明 是否必须 数据类型 默认值
phone 用户的手机号码 是 String 无

返回结果:

无

# 4. 用户注册

功能说明:

实现用户注册功能,需要对用户密码进行加密存储,使用MD5加密,加密过程中使用随机码作为salt加盐。另外还需要对用户输入的短信验证码进行校验。

接口路径:

POST /ums/user/register
1

参数说明:

form表单格式

参数 说明 是否必须 数据类型 默认值
username 用户名,格式为4~30位字母、数字、下划线 是 String 无
password 用户密码,格式为4~30位字母、数字、下划线 是 String 无
mobile 手机号码 是 String 无
email 邮箱 是 String 无
code 短信验证码 是 String 无

返回结果:

无返回值。

# 5. 根据用户名和密码查询用户

功能说明:

查询功能,根据参数中的用户名和密码查询指定用户

接口路径:

GET /ums/user/query
1

参数说明:

form表单格式

参数 说明 是否必须 数据类型 默认值
username 用户名,格式为4~30位字母、数字、下划线 是 String 无
password 用户密码,格式为4~30位字母、数字、下划线 是 String 无

返回结果:

用户的json格式数据

编辑 (opens new window)
上次更新: 2024/06/15, 15:12:25
后台管理系统接口文档

← 后台管理系统接口文档

最近更新
01
04.Spring Boot 韩顺平
10-12
02
day14
08-29
03
day09
08-29
更多文章>
Theme by Vdoing | Copyright © 2019-2025 Evan Xu | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式