Skip to content

code-magic-record/api

Repository files navigation

API

练习简单的 API 接口开发设计

指引

欢迎来到我的 api 仓库!这个仓库是一个基于 Express 框架、MySQL 数据库、Knex 查询构建器和 Redis 缓存的示例项目。

快速开始:

  1. 拷贝 .env.example 文件,重命名为 .env,并修改其中的配置项。
  2. 安装mysql数据库,创建数据库,导入sql文件 表结构查看sql文件夹
  3. 安装依赖:npm install
  4. 启动项目:npm run dev

目前实现的接口 API 进度

api在线文档

user

  • 注册
  • 管理员登录
  • 登录
  • 退出登录
  • 获取个人信息

--- 暂不做---

  • 修改个人信息

address

  • 获取地址
  • 新增地址
  • 编辑地址 -- 当前是做一个删除,然后新增的,需要优化成根据 id 编辑
  • 删除地址

goods

  • 获取商品列表
  • 获取商品详情
  • 新增商品
  • 编辑商品
  • 删除商品

--- 分类暂时可以不做 ---

  • 新增分类
  • 编辑分类
  • 获取分类列表

order

  • 获取用户订单列表
  • 用户下单
  • 用户付款
  • 确认收货

--- 暂时不做 ---

  • 订单发货

upload

  • 上传文件