# financial_manual_server

**Repository Path**: winshu/financial_manual_server

## Basic Information

- **Project Name**: financial_manual_server
- **Description**: 财务手册后台服务
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-25
- **Last Updated**: 2023-10-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 财务手册后台服务

## 功能列表

- web 服务器功能
- 评论功能

默认端口 3000， 启动时可指定端口
默认上下文路径 /fm 启动时可指定上下文路径

启动示例 `financial_manual_server 3000 /financial` (参数为可选)  
访问示例 `http://localhost:3000/financial/`

支持从文件加载配置，文件名称`config.json`

```json
{
  "server": {
    "port": 3000,
    "contextPath": "/financial"
  },
  "wxWork": {
    "url": "https://chief-te.yifengx.com/fire-mps/UserAuthService/getUrl",
    "merchantId": "5c49b2b72adc9100015f02ca",
    "mpAppId": "wx6e6914c171b26e86",
    "appRedirectUrl": "https://mdwx-test.yfdyf.com/financial/"
  },
  "wxUser": {
    "url": "http://192.168.5.60:8084/getUser",
    "agentId": "1000045",
    "type": "dev"
  },
}
```

## 接口列表

### 1. 查询指定文档评论
#### 请求地址
GET /comments/<文档ID>

#### 请求参数
无

#### 响应参数
```json
{
    "code": 0,                                         // 结果码， 0 成功
    "data": {                                          // 返回数据
        "comments": [{
            "id": 21,                                  // 评论ID
            "pid": 0,                                  // 原评论ID， 不为0时表示是回复的评论
            "docId": "2021042201",                     // 文档ID
            "userId": "10000",                         // 评论人ID
            "userName": "狗蛋",                        // 评论人名称
            "quoteId": "10086",                        // 引用人ID
            "quoteName": "王富贵",                     // 引用人名称
            "content": "这里是评论内容",                // 评论内容
            "createTime": "2021-04-25 09:21:24",       // 创建时间
            "agreeCount": 10,                          // 赞同数
            "replies": [{                              // 回复的评论
                 "id": 22,
                 "pid": 21,
                 "docId": "2021042201",
                 "userId": "00182813",
                 "userName": "wangqiao",
                 "quoteId": "",
                 "quoteName": "",
                 "content": "假装有一段文字",
                 "createTime": "2021-04-25 09:33:05",
                 "agreeCount": 10,
                 "replies": []
                }]
            }],
	    "total": 2                                   // 评论总数
    },
    "message": "成功"                                  // 返回消息
}
```

### 2. 提交评论
#### 请求地址
POST /comments/<文档ID>

#### 请求参数
```json
{
    "pid":   1,                 // 原评论的ID
    "docId": "2021042201",      // 文档ID      
    "userId": "00182814",       // 评论人ID
    "userName": "winshu",       // 评论人名称
    "quoteId": "00182813",      // 引用人ID
    "quoteName": "wangqiao",    // 引用人名称
    "content": "这里是评论内容"  // 评论内容
}
```

#### 响应参数
```json
{
    "code": 0,         // 结果码，0 成功
    "data": null,      // 返回数据
    "message": "成功"  // 返回消息
}
```

### 3. 删除评论
#### 请求地址
DELETE /comments/<评论ID>

#### 请求参数
无

#### 响应参数
```json
{
    "code": 0,         // 结果码，0 成功
    "data": null,      // 返回数据
    "message": "成功"  // 返回消息
}
```

#### 说明
删除评论时，会删除评论下面的回复

### 4. 赞同评论
#### 请求地址
POST /comments/<评论ID>/agree

#### 请求参数
无

#### 响应参数
```json
{
    "code": 0,         // 结果码，0 成功
    "data": null,      // 返回数据
    "message": "成功"  // 返回消息
}
```

#### 说明
前端需要做防重复提交控制

## 编译

```bat
# windows
go build -o financial_manual_server.exe
```
```shell script
# linux
go build -o financial_manual_server
```

#### 安全目录 _safe

服务下的_safe目录是不允许访问的，可用于存放隐私文件，比如数据文件