# go-apiServer

**Repository Path**: pangqianjin/go-api-server

## Basic Information

- **Project Name**: go-apiServer
- **Description**: GO语言编写的静态资源服务器，也可用于mock JSON请求
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-01-14
- **Last Updated**: 2023-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Iris, Mock, Go语言

## README

# go-apiServer

#### 介绍
GO语言编写的静态资源服务器，也可用于mock JSON请求，自用

#### 软件架构
使用全宇宙最快的go框架Iris编写


#### 安装教程

1.  $```go get github.com/kataras/iris/v12@master # or @v12.2.0-beta7```

#### 使用说明
- <u>tip：windows系统运行后，若命令行卡住，可以按一下回车</u>

1. property-config.json请参考默认的配置
```json
{
    "port": "9998",
    "data_path": "E:/fqfin/visionary-server/mockData",
    "public_path": "E:/fqfin/server-public/resource/statics",
    "public_prefix": "./statics",
    "debug_level": "info",
    "memory_cache": false
}
```
2. 默认使用9999端口，如冲突请修改为其他即可
3. 默认配置./mockData为JSON文件夹, 最多支持三层嵌套`/xx/xx/xx[.post | .delete | .put | .patch].json`
    - 拷贝你的JSON文件夹到mockData下，如 /mockData/api/*.json
    - \*.json可用于GET请求，*.post.json用于POST请求, PUT，DELETE，PATCH等依次类推
4. 静态资源目录请配置public_path字段，资源的请求路径需要以`public_prefix`字段配置的值开头，默认为`/statics`
5. 日志等级请配置debug_level字段，默认为info
6. 是否开启内存缓存请配置memory_cache字段，开启时会很吃内存且初次启动慢（卡住请等待），但是响应超级快；建议默认关闭该选项
7. 日志自定义请配置logger-config.json
```json
{
    "status": true,
    "ip": true,
    "method": true,
    "path": true,
    "query": true
}
```
8. go-apiServer为macos m1可用，go-apiServer.exe为amd64可用，其他操作系统请自行编译

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request