# ui_api_chart

**Repository Path**: ff2266/seves

## Basic Information

- **Project Name**: ui_api_chart
- **Description**: 心语app接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-04-29
- **Last Updated**: 2023-04-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 心语后台接口

## 安装依赖
```
npm install
```

### 启动项目
```
node main.js  或者 npm run dev
```

### 接口文档
1.生成接口文档
apidoc -i router/ -o apidoc/

2.访问接口文档
http://localhost:3086

3.官方文档
https://apidocjs.com/#param-api-param

# API 返回值说明

[接口文档规则](https://blog.csdn.net/xiaoxgongzs/article/details/120625813)

## 请求返回示例

```json
{
     "code" : 200,
     "message" : "params missing",
     "data" : "Object [NULL | NOT NULL]"
}
```

## HTTP 状态码
code | 描述 | 说明
--- | --- | ---
-1 | 错误提交 | 具体看返回的错误信息
200 | 成功提交 | 请求成功，一般用于GET与POSt请求
201 | 成功提交 | [POST/PUT/PATCH]：用户新建或修改数据成功
202 | 成功提交 | 表示一个请求已经进入后台排队（异步任务）
204 | 成功提交 | 用户删除数据成功
301 | 重定向 | 永久重定向
302 | 重定向 | 临时重定向
400 | 请求错误 | [POST/PUT/PATCH]：用户发出的请求有错误
401 | 鉴权失败 | token过期或者不正确，重新登录(账号密码错误)
403 | 访问禁止 | 访问是被禁止的
404 | 路由不存在或者资源不存在 | 访问的url不存在或者对应资源不存在
406 | 请求格式错误 | 用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）
407 | 请求数据不存在 | 请求数据不存在
410 | 请求资源被删除 | 用户请求的资源被永久删除，且不会再得到的
500 | 服务器内部错误 | 内部服务器出错
501 | 服务器内部错误 | 服务器不支持请求的功能，无法完成请求