KAPI Cli

deprecated, use https://github.com/linxlib/kapi/tree/main/cmd/k instead

安装

go install github.com/linxlib/k@latest

或者clone代码进行编译

git clone https://github.com/linxlib/k
# windows
$Env:GOOS="windows"
go build -o k.exe main.go

# mac os
GOOS=darwin go build -o k main.go

#linux
GOOS=linux go build -o k main.go

需要将可执行程序放到PATH目录下，建议使用第一种方法进行安装，会自动安装到$GOPATH/bin目录

使用

k i
k init # 生成空项目
k build # 根据build.toml进行编译
k build -t=nomsgpack # 不使用gin引用的msgpack，可以减少大小
k build -g # 编译前运行一下，生成文档和注册路由
k run # 运行 可以检测代码修改重新运行（目前的速度有点慢，体验不是很好）
etc....

命令

• k init 用于在go.mod存在的情况下为你生成build.toml config.toml Dockerfile main.go 并执行go mod tidy

• k run 运行, 监听源码变动, 重新运行

• k 不带参数运行则默认为run

• k build 依赖项目根目录下的 build.toml 文件, 目前版本会在构建后一起拷贝 gen.gob swagger.json 和配置文件到构建目录(配置文件已存在则不覆盖)

# 编译配置
[k]
  name = "api_base" # 编译的可执行文件名
  version = "1.0.0" # 版本
  arch = "amd64"  # 平台
  system = "darwin" # 系统
  path = "./bin" # 输出目录

使用k编译的kapi程序, 运行时将输出相关日志信息, 例如

--------------------------------------------
    _/    _/    _/_/    _/_/_/    _/_/_/
   _/  _/    _/    _/  _/    _/    _/
  _/_/      _/_/_/_/  _/_/_/      _/
 _/  _/    _/    _/  _/          _/
_/    _/  _/    _/  _/        _/_/_/

 Version:   1.0.0/go1.16.6
 OS/Arch:   windows/amd64
 BuiltTime: 2021-08-20T11:31:08
-------------------------------------------- 

如果build.toml不存在, 则只会在./bin目录下输出当前系统的可执行程序(相当于 go build main.go), 可以输入k init 生成这个文件

• 新增 k build -t=nomsgpack 可以带tags进行编译
• 新增生成模式 -g, 在编译前先生成gen.gob和swagger.json