# koa-deme

**Repository Path**: funnywuss/koa-deme

## Basic Information

- **Project Name**: koa-deme
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 接口文档

[TOC]

## 用户注册

### 请求URL

```
http://localhost:3000/api/users/register
```

### 请求方式

```
POST
```

### 参数类型 param

| 参数     |   是否必选   |   类型   |  说明    |
| ---- | ---- | ---- | ---- |
|   name   | N | string | 用户名 |
|   password   | Y | string | 密码 |
|   email   | Y | string | 邮箱 |
| avatar | N | string | 头像 |

### 返回示例

```json
{
    "date": "2020-04-23T04:57:35.239Z",
    "_id": "5ea1221a2ad39b08d0a06273",
    "name": "test",
    "email": "test@test.com",
    "avatar": "//www.gravatar.com/avatar/b642b4217b34b1e8d3bd915fc65c4452?s=200&r=pg&d=mm",
    "password": "$2b$10$cWRtk9uGJPXwSWJWgtp4WurSgt/w3E6dqErgGfnSpQc8j8P5Vm.xG",
    "__v": 0
}
```



## 用户登录

### 请求 URL

```
http://localhost:3000/api/users/login
```



### 请求方式

```
POST
```

### 参数类型 param

| 参数     | 是否必选 | 类型   | 说明 |
| -------- | -------- | ------ | ---- |
| email    | Y        | string | 邮箱 |
| password | Y        | string | 密码 |

### 返回示例

```json
{
"success": true,
"token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlYTExYWE2MzI1MGNhNTZhMDBlYmU5YyIsIm5hbWUiOiJmdW5ueSIsImF2YXRhciI6Ii8vd3d3LmdyYXZhdGFyLmNvbS9hdmF0YXIvN2NmNTExYzI4YzhhMmVjOWNiZjkyODk3MjA0ZDJkZjQ_cz0yMDAmcj1wZyZkPW1tIiwiaWF0IjoxNTg3NjE4ODM5LCJleHAiOjE1ODc2MjI0Mzl9.CvMoSFaUANLWG6rTWRE-TSukpFn9M6ITPH7T10RqGM4"
}
```