前端接口文档（初）

Web前端必须要写一个接口文档来帮助使用项目

注：'npm init'

'npm init -y'

###安装项目依赖（包） 'npm install' 'npm install 包名 --save' --save简写-S 'npm install 包名 -g' -g全局 'npm install 包名@版本号 --save/-g' 没有版本号装的是最新的

'npm update ...' 更新

'npm uninstall 包名 -g' 删除 不加-g删除当前项目 加-g是全局

接口文档:

0.base=http://localhost:3000

1.标签操作

1.1添加标签

请求地址：http://localhost:3000/tag

请求方法：POST

请求参数：

参数名	参数类型	必填	参数说明
text	string	是	标签内容

示例：
```json
{
    "text":"6"
}
```

请求响应：

    {
        status:200,   //200代表成功，其他的代表失败
        data:[],  //请求成功之后返回的数据
        msg:""  //请求失败之后，返回的错误信息
    }

1.2查询标签

请求地址：http://localhost:3000/tag

请求方法：GET

请求参数：无

示例：
```json
{
    "text":"6"
}
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

1.3删除标签

请求地址：http://localhost:3000/tag

请求方法：DELETE

请求参数：

参数名	参数类型	必填	参数说明
_id	string	是	标签id

示例：

```json
  { 
"_id":"61a5c11b22beea0274420145" 
 }
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

2.用户操作

2.1用户查询

请求地址：http://localhost:3000/user

请求方法：GET

请求参数：无

请求响应：

    {
        status:200,   //200代表成功，其他的代表失败
        data:[],  //请求成功之后返回的数据
        msg:""  //请求失败之后，返回的错误信息
    }

2.2用户标签

请求地址：http://localhost:3000/user

请求方法：POST

请求参数：

参数名	参数类型	必填	参数说明
username	string	是	用户名称
userpaw	string	是	用户密码
usereaml	string	是	用户邮箱
useryh	string	是	用户类型

示例：
```json
       {
     "username":"123ada",
     "userpaw":"asdasdasdas",
     "usereaml":"123456a@qq.com",
     "useryh":"注册会员"
  }

```

请求响应：

    {
        status:200,   //200代表成功，其他的代表失败
        data:[],  //请求成功之后返回的数据
        msg:""  //请求失败之后，返回的错误信息
    }

2.3删除用户

请求地址：http://localhost:3000/user

请求方法：DELETE

请求参数：

参数名	参数类型	必填	参数说明
_id	string	是	用户内容

示例：

```json
  { 
   "_id":"61a8805aa8b61d4c4649c429" 
  }
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

2.4修改用户

请求地址：http://localhost:3000/user?_id

请求方法：PUT

请求参数：

参数名	参数类型	必填	参数说明
_id	string	是	用户内容
usereaml	string	是	用户邮箱内容

示例：

```json
  { 
   "_id":"61a8805aa8b61d4c4649c429" 
  }
  {
  "usereaml":"654321a@qq.com",
  }
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

2.内容操作

2.1内容查询

请求地址：http://localhost:3000/content

请求方法：GET

请求参数：无

请求响应：

    {
        status:200,   //200代表成功，其他的代表失败
        data:[],  //请求成功之后返回的数据
        msg:""  //请求失败之后，返回的错误信息
    }

2.2内容添加

请求地址：http://localhost:3000/content

请求方法：POST

请求参数：

参数名	参数类型	必填	参数说明
title	string	是	内容标题
content	string	是	内容正文
top	boolean	是	是否顶置

示例：
```json
    {
    "title":"taoshilin",
    "content":"dadadaddadada",
    "top":false
    }

```

请求响应：

    {
        status:200,   //200代表成功，其他的代表失败
        data:[],  //请求成功之后返回的数据
        msg:""  //请求失败之后，返回的错误信息
    }

2.3删除用户

请求地址：http://localhost:3000/content

请求方法：DELETE

请求参数：

参数名	参数类型	必填	参数说明
_id	string	是	内容id

示例：

```json
  { 
"_id":"61a5d87aaf509f1bd50e4aab" 
  }
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

2.4修改用户

请求地址：http://localhost:3000/content?_id

请求方法：PUT

请求参数：

参数名	参数类型	必填	参数说明
_id	string	是	内容id
top	boolean	是	是否顶置

示例：

```json
  { 
   "_id":"61a5d87aaf509f1bd50e4aab" 
  }
  {
  "top":false
  }
```

请求响应：

    {
        "status":200,   //200代表成功，其他的代表失败
        "data":[],  //请求成功之后返回的数据
        "msg":""  //请求失败之后，返回的错误信息
    }

请求工具：apipost

（新建接口）

（流程图）