# admin-api-demo

**Repository Path**: secretx500/admin-api-demo

## Basic Information

- **Project Name**: admin-api-demo
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-16
- **Last Updated**: 2020-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目说明

> 说明

这个项目主要是提供了简单的几个 `curd` 接口

为了学习类似 `redux-saga` 和 `dva.js` 这样的周边项目提供环境支持

> 安装依赖

```bash
npm i
```

> 创建数据库导入数据(MySQL | MariaDB)

```bash
# 安装 sequelize-cli:
npm i sequelize-cli

# 创建数据库
sequelize db:create --charset "utf8mb4"

# 迁移数据表
sequelize db:migrate

# 填充数据
sequelize db:seed:all
```

> 修改配置

找到 `/config/config.json` 可以修改数据库链接设置

- 修改运行端口
- 修改数据库链接配置

### 接口文档

> 测试服务器是否运行

- `/api/ping`
- 参数示例: 无

> 登录

- POST `/api/login`
- 参数示例:

```js
{
  "username": "admin", // 用户名
  "password": "123456" // 密码
}
```

> 文章列表

- GET `/api/article`
- 参数示例:

```js
{
  "page": 1, // 当前页
  "page_size": 10, // 每页多少条数据(可选)
}
```

> 创建文章

- POST `/api/article`
- 参数示例:

```js
{
  "title": "标题", // 文章标题
  "content": "文章内容", // 文章内容
}
```

> 修改文章数据

- PATCH `/api/article/:id`
- 参数示例:

```js
{
  "title": "标题", // 文章标题(可选)
  "content": "文章内容", // 文章内容(可选)
}
```

> 删除文章数据

- DELETE `/api/article/:id`
- 参数示例: 无

> 获取文章详情

- GET `/api/article/:id`
- 参数示例: 无