# koa2-blog

**Repository Path**: happylusn/koa2-blog

## Basic Information

- **Project Name**: koa2-blog
- **Description**: Blogging platform built using Layui
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-29
- **Last Updated**: 2022-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 接口文档

## 目录：
[1、注册](#1注册)<br/>
[2、登陆](#2登陆)<br/>
[3、更新用户信息](#3更新用户信息)<br/>
[4、获取当前的user(根据cookie)](#4获取当前的user(根据cookie))<br/>
[5、获取用户列表](#5获取用户列表)<br/>
[6、获取当前用户的聊天消息列表](#6获取当前用户的聊天消息列表)<br/>
[7、 修改指定消息为已读](#7修改指定消息为已读)<br/>


## 1、注册

### 请求URL：
	localhost:3005/register

### 请求方式：
	POST

### 参数类型

	|参数		|是否必选 |类型     |说明
	|username    |Y       |string   |用户名
	|password    |Y       |string   |密码
	|type        |Y       |string   |类型

### 返回示例：
	成功:
	    {
	      "code": 0,
	      "data": {
	        "_id": "5ae133e621388d262c8d91a6",
	        "username": "ds2",
	        "type": "dashen"
	      }
	    }
	失败
	    {
	      "code": 1,
	      "msg": "此用户已存在"
	    }


## 2、登陆

### 请求URL：
	localhost:3005/login

### 请求方式：
	POST

### 参数类型

	|参数		|是否必选 |类型     |说明
	|username    |Y       |string   |用户名
	|password    |Y       |string   |密码

### 返回示例：
	成功:
	    {
	      "code": 0,
	      "data": {
	        "_id": "5ae1338a21388d262c8d91a5",
	        "username": "ds1",
	        "type": "dashen",
	        "__v": 0
	      }
	    }
	失败
	    {
	      "code": 1,
	      "msg": "用户名或密码错误"
	    }

## 3、更新用户信息

### 请求URL：
	localhost:3005/update

### 请求方式：
	POST

### 参数类型：

	|参数		|是否必选 |类型     |说明
	|header    |Y       |string   |头像名称
	|info      |N       |string   |介绍
	|post      |N       |string   |职位
	|salary    |N       |string   |月薪
	|company   |N       |string   |公司

### 返回示例：
	成功:
	    {
		    "code": 0,
		    "data": {
		        "header": "头像2",
		        "info": "react/vue",
		        "post": "前端工程师",
		        "company": "Oracle",
		        "salary": "18K",
		        "_id": "5ae1f088d37a442b749fc143",
		        "username": "laoban1",
		        "type": "laoban"
		    }
		}
	失败
	    {
	      "code": 1,
	      "msg": "请先登陆"
	    }


## 4、获取当前的user(根据cookie)

### 请求URL：
	localhost:3005/user

### 请求方式：
	GET

### 参数类型

	无

### 返回示例：
	成功:
	    {
		    "code": 0,
		    "data": {
		        "_id": "5ae1f088d37a442b749fc143",
		        "username": "laoban1",
		        "type": "laoban",
		        "__v": 0,
		        "salary": "18K",
		        "company": "Oracle",
		        "post": "前端工程师",
		        "info": "react/vue",
		        "header": "头像2"
		    }
		}
	失败
	    {
	      "code": 1,
	      "msg": "请先登陆"
	    }


## 5、获取用户列表

### 请求URL：
	localhost:3005/userlist

### 请求方式：
	GET

### 参数类型

	|参数		|是否必选 |类型     |说明
	|type       |Y       |string   |类型(dashen/laoban)

### 返回示例：
	{
	    "code": 0,
	    "data": [
	        {
	            "_id": "5ae1d5d19151153d30e008fd",
	            "username": "ds2",
	            "type": "dashen",
	            "__v": 0
	        },
	        {
	            "_id": "5ae1ddd99ca58023d82351ae",
	            "username": "aa",
	            "type": "dashen",
	            "__v": 0,
	            "post": "前端工程师",
	            "info": "Rect/Vue",
	            "header": "头像1"
	        }
	    ]
	}
	

## 6、获取当前用户的聊天消息列表

### 请求URL：
	localhost:3005/msglist

### 请求方式：
	GET

### 参数类型
	无

### 返回示例：
	{
	    "code": 0,
	    "data": {
	        "users": {
	            "5ae1d5d19151153d30e008fd": {
	                "username": "ds2"
	            },
	            "5ae1ddd99ca58023d82351ae": {
	                "username": "aa",
	                "header": "头像1"
	            },
	            "5ae1df049ca58023d82351af": {
	                "username": "aa2"
	            },
	            "5ae1e72aa072c522e024b18e": {
	                "username": "bb",
	                "header": "头像3"
	            },
	            "5ae1f088d37a442b749fc143": {
	                "username": "laoban1",
	                "header": "头像2"
	            }
	        },
	        "chatMsgs": [
				{
	                "read": false,
	                "_id": "5ae1f3c3a95eb824841199f1",
	                "from": "5ae1f088d37a442b749fc143",
	                "to": "5ae1ddd99ca58023d82351ae",
	                "content": "aa",
	                "create_time": 1524757443374,
	                "__v": 0
	            }
			]
	    }
	}

## 7、 修改指定消息为已读