# api.sunliang.cc

**Repository Path**: diguoyihao/api.sunliang.cc

## Basic Information

- **Project Name**: api.sunliang.cc
- **Description**: 我的golang接口库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-11
- **Last Updated**: 2024-12-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 项目编译

```bash
# 克隆项目
git clone https://gitee.com/diguoyihao/api.sunliang.cc.git

# 进入tool_flash_cn_go文件夹
cd api.sunliang.cc

# 使用 go mod 并安装go依赖包
go get

# 编译（开发）
go build -o api-sunliang-cc main.go

# Gin默认开启MsgPack渲染，未使用MsgPack可关闭
# 通过指定构建标记来禁用此功能，这对于减小可执行文件的二进制大小很有用
go build -tags=nomsgpack .

# 编译并压缩（上线优化）
go build -tags=nomsgpack -ldflags='-s -w' -o api-sunliang-cc main.go && upx -9 api-sunliang-cc

# 容器下编译需静态编译
go build -tags=nomsgpack -ldflags='-s -w -extldflags "-static"' -o api-sunliang-cc main.go && upx -9 api-sunliang-cc
```

### 项目运行
```bash
# 运行二进制项目，默认配置
./api-sunliang-cc (windows运行命令为 api-sunliang-cc.exe)

# 运行二进制项目，自定义配置（Linux）
./api-sunliang-cc -model debug -port 4455

# 查看项目配置
/go/src/api.sunliang.cc # ./api-sunliang-cc --help
Usage of ./api-sunliang-cc:
  -env string
        server runtime environment(dev,fat,uat or prod) (default "dev")
  -model string
        runtime model debug or release (default "release")
  -port int
        server runtime env port (default 8090)

# 后台运行
nohup ./api-sunliang-cc  > /dev/null 2>&1 &
```

### 心跳检查
```bash
# head请求
http://127.0.0.1:8090/health
# get请求
http://127.0.0.1:8090/health
```

### 单元测试
```bash
cd ./unittest
# 测试单个单元测试
go test -v sensitive_test.go main_test.go
# 测试全部单元测试
go test -v
```