Vue 3 —— M / 接口文档
接口文档大纲(12-接口文档)
一、整体说明
1. 启动方式:克隆并启动 vue3-node-server 本地服务
- 地址:http://localhost:4000/api
2. 浏览器插件推荐:FeHelper(JSON 格式化)
二、轮播图
- GET /banner
- 无参
- 返回:图片 URL 数组
三、用户模块
1. 登录
- POST /login
- Body:{ username, password }
- 返回:token、权限、状态等
2. 获取用户信息
- GET /profile
- Header:Authorization: Bearer ${token}
- 返回:id、用户名、姓名、头像、创建时间
四、文章模块
1. 列表
- GET /article?current=1&pageSize=10
- Header:Authorization
- 返回:分页信息 + rows 文章数组
2. 详情
- GET /article/:id
- Header:Authorization
- 返回:文章完整字段
3. 新增
- POST /article
- Header:Authorization
- Body:{ stem, content }
- 返回:新增文章对象
4. 修改
- PUT /article/:id
- Header:Authorization
- Body:{ stem?, content? }
- 返回:更新后文章对象
5. 删除
- DELETE /article/:id
- Header:Authorization
- 返回:null(成功)
五、通用响应格式
- code:10000 成功
- message:提示文本
- data:业务数据