# subject-server

**Repository Path**: zhang_hf/subject-server

## Basic Information

- **Project Name**: subject-server
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-04-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 后端接口业务相关说明

[文档地址](http://47.104.160.105:3030/apidoc/)

## 用户模块

- [x] 用户管理添加(/user/reg)
  - 0-> 超级管理员；1-> 普通管理员；超级管理员不允许随意注册；
  - 系统初始化时会默认创建一个 admin/admin 超级管理员账号；
- [ ] 用户管理删除(/user/delete)
- [ ] 用户管理修改(/user/update)
  - 用户头像修改时，物理删除原来的图片；
- [x] 单个用户信息查询(/user/info)
- [ ] 所有用户列表查询(/user/list)

## 菜单模块

- [x] category  菜单分类
  - [x] 添加 (/category/add)
  - [x] 删除(当前分类下没有菜单才可以删除)(/category/delete)
  - [x] 修改(/category/update)
  - [x] 查询 (/category/query)
- [x] menu 菜单
  - [x] 添加 (必须关联菜单分类)(/menu/add)
  - [x] 删除(/menu/delete)
  - [x] 修改(/menu/update)
  - [x] 查询(/menu/allList)
  - [x] 根据 cid 查询(/menu/getListByCid)

## API 返回数据说明

## 接口文档更新

文档使用[http://apidocjs.com/](http://apidocjs.com/)根据接口代码注释规范自动生成文档，生成、更新方式如下:

```js
// 安装命令行工具
npm install apidoc -g

// 运行更新命令
npm run doc

// 生成完成后启动服务，访问 http://127.0.0.1:3030/apidoc/ 可查看文档
npm run dev
```