# 服务端-后端

**Repository Path**: next-studio/next-station-server

## Basic Information

- **Project Name**: 服务端-后端
- **Description**: 下一站是一款开源的移动应用，专注于为北京的地铁乘客提供便捷、准确、全面的地铁出行服务。通过这款应用，您可以轻松查看各个地铁线路的详细百科信息，下载实用的地图，获取最新的公告信息。我们的目标是让您的出行更加轻松愉快。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-07
- **Last Updated**: 2025-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 下一站-北京 服务器启动

# 下一站-北京 后端配置文件

配置文件编码需为utf-8

```json
{
	"mysql":{
        "user":"数据库用户名",
        "password":"数据库密码",
        "host":"主机",
        "port":"端口"
    },
    "server":{
        "domain":"h.com",
        "port":80 // 启动端口
    },
    "jwt":{
        "time":365, //token过期时间,单位为天
        "key":"jwt加密密钥"
    },
    "save-log":true, // 是否保存日志
    "debug-mode":false // 是否开启flask调试模式（服务器不建议开启）
}
```

# 下一站-北京 后端api

## 获取前端配置

路由：/api/config/getApp

类型：GET

body：无

返回：

```json
{
    "code":200,
    "message":"获取成功",
    "data":{}
}
```

## 修改前端配置

路由：/api/config/setApp

类型：POST

body：（前端配置）

返回：

```json
{
    "code":200,
    "message":"配置更新成功"
}
```

## 用户登录

路由：/api/user/login

类型：POST

body：（json字符串）

```json
{
    "phone":"",
    "password":"",
}
```

返回：

set-cookie：JWT，

```json
{
    "code":200,
    "message":"错误消息",
    "data":{
        "id":,
        "username":"",
    	"phone":""
    }
}
```

## 用户注册

路由：/api/user/register

类型：POST

body：（json字符串）

```json
{
    "username":"",
    "password":"",
    "phone":""
}
```

返回：

set-cookie：JWT，

```json
{
    "code":200,
    "message":"错误消息",
    "data":{
        "username":"",
    	"phone":""
    }
}
```

## 修改头像

路由：/api/user/setAvatar

类型：POST

body：（json字符串）

```json
{
    "id":,
    "avatar":""
}
```

返回：

```json
{
    "code":200,
    "message":"错误消息"
}
```

## 获取头像

路由：/api/user/getAvatar/{id}

类型：GET

body：无

返回：

```json
{
    "code":200,
    "message":"",
    "avatar":""
}
```

## 获取用户信息

路由：/api/user/getUserInfo/{id}

类型：GET

body：无

返回：

```json
{
    "code":200,
    "message":"",
    "data":{
        "id":,
        "username":"",
        "phone":"", // 手机号仅有自己和管理员可见
        "type":"",
        "create_at":"",
        "have_avatar":, // 是否有头像
        "ban":false
    }
}
```

## 修改用户信息

路由：/api/user/setUserInfo

类型：POST

body：（json字符串）

```json
{
    "id":,
    "data":{
        "username":"",
        "phone":"",
        "type":"",
        "ban":false
    }
}
```

返回：

```json
{
    "code":200,
    "message":""
}
```

## 注销用户

路由：/api/user/logOff/{id}

类型：DELETE

body：无

返回：

set-cookie：空

```json
{
    "code":,
    "message":""
}
```

## 新增资讯

路由：/api/news/add

类型：POST

body：（json字符串）

```json
{
    "title":"",
    "context":"",
    "preview":""
}
```

返回：

```json
{
    "code":,
    "message":""
}
```

## 上传封面

路由：/api/news/cover

类型：POST

body：（json字符串）

```json
{
    "id":,
    "cover":""
}
```

返回：

```json
{
    "code":,
    "message":""
}
```

## 删除资讯

路由：/api/news/delete/{id}

类型：DELETE

body：无

返回：

```json
{
    "code":,
    "message":""
}
```

## 获取资讯信息

路由：/api/news/getInfo/{id}

类型：GET

body：无

返回：

```json
{
    "code":,
    "message":"",
    "data":{
        "id":,
        "title":"",
        "context":"",
        "views":,
        "post_time":"",
        "is_pass":,
        "likes":,
        "is_like":,
        "has_cover":,
        "user":{
            "id":,
            "username":"",
            "type:":"",
            "create_at":"",
            "ban":
        }
    }
}
```

## 获取封面

路由：/api/news/getCover/{id}

类型：GET

body：无

返回：

```json
{
    "code":,
    "message":"",
    "cover":""
}
```

## 点赞

路由：/api/news/like

类型：POST

body：（json字符串）

```json
{
    "news_id":,
    "like":true, // true为点赞，false为取消点赞
    "comment_id": // 评论id，为null表示为资讯点赞
}
```

返回：

```json
{
    "code":,
    "message":"",
}
```

## 搜索资讯

路由：/api/news/search?key=

类型：GET

body：无

返回：

```json
{
    "code":,
    "message":"",
    "data":[
        {
            "id":,
            "title":"",
            "views":,
            "post_time":"",
            "is_pass":,
            "is_like":,
            "likes":,
            "has_cover":,
            "user":{
                "id":,
                "username":"",
                "type:":"",
                "create_at":"",
                "ban":
            }
        },
    ]
}
```

## 获取资讯列表

路由：/api/news/getList

类型：GET

参数：

|参数名|说明   |
|-----|-------|
|page |页码    |
|limit|每页数量|
|type |获取方式|

type为time时，按时间排序；
type为views时，按浏览量排序；

返回：

```json
{
    "code":200,
    "message":"",
    "total":, // 总页数
    "data":[
        {
            "id":,
            "title":"",
            "views":,
            "post_time":"",
            "is_pass":,
            "is_like":,
            "likes":,
            "has_cover":,
            "user":{
                "id":,
                "username":"",
                "type:":"",
                "create_at":"",
                "ban":
            }
        },
    ]
}
```

## 上传版本

路由：/api/version/upload

类型：POST

body：（json字符串）

```json
{
    "url":"",
    "version":"",
    "log":""
}
```

返回：

```json
{
    "code":,
    "message":"",
}
```

## 获取最新版本

路由：/api/version/getLatest

类型：GET

body：无

返回：

```json
{
    "code":,
    "message":"",
    "data":{
        "url":"",
        "version":"",
        "log":""
    }
}
```

## 获取版本列表

路由：/api/version/getList

类型：GET

body：无

返回：

```json
{
    "code":,
    "message":"",
    "data":[
        {
            "url":"",
            "version":"",
            "log":""
        },
    ]
}
```

## 删除版本

路由：/api/version/delete/{id}

类型：DELETE

body：无

返回：

```json
{
    "code":,
    "message":"",
}
```

## 添加评论

路由：/api/news/addComment

类型：POST

body：（json字符串）

```json
{
    "news_id":,
    "content":"",
    "reply_id": // 回复的评论id，直接评论则为null
}
```

返回：

```json
{
    "code":,
    "message":"",
    "id":
}
```

## 删除评论

路由：/api/news/deleteComment/{id}

类型：DELETE

body：无

返回：

```json
{
    "code":,
    "message":"",
}
```