An open API service indexing awesome lists of open source software.

https://github.com/y19941115mx/ygo

参考hade http://hade.funaio.cn 内置orm, web server,配置管理等多种基础服务,win/linux跨系统可用,支持丰富命令行工具的go服务端开发框架
https://github.com/y19941115mx/ygo

golang web

Last synced: about 1 month ago
JSON representation

参考hade http://hade.funaio.cn 内置orm, web server,配置管理等多种基础服务,win/linux跨系统可用,支持丰富命令行工具的go服务端开发框架

Awesome Lists containing this project

README

          

# Ygo 框架
## 使用文档

[《Ygo框架使用文档》](https://y19941115mx.netlify.app/)

## 使用说明

### 框架安装

编译环境依赖:
1. go 开发环境
2. gcc 开发环境

远程编译安装
```
go install github.com/y19941115mx/ygo@latest
```

本地编译安装
```
cd 项目根路径
go install
```
### 使用

如果编译安装成功,运行 `ygo` 命令,即可直接查看框架命令的使用介绍

![](framework/doc/demo1.png)

如本地编译失败,请到 [release页面](https://github.com/y19941115mx/ygo/releases) 下载对应操作系统的可执行文件,并将可执行文件的路径添加到系统的环境变量中

### 运行

```
ygo app start
```
访问浏览器[127.0.0.1:8888/swagger/index.html](127.0.0.1:8888/swagger/index.html) 即可访问demo的接口文档:

![](framework/doc/demo2.png)

### 运行测试用例

编辑文件`test/env.go`,设置项目根路径地址`BasePath`

```
cd test

go test -v
```
启动可视化测试页面
1. 安装 goconvey
`go install github.com/smartystreets/goconvey`
2. 执行命令,启动可视化测试web服务
```
cd test

goconvey
```
3. 访问web服务:
[http://127.0.0.1:8080](http://127.0.0.1:8080/)
![](framework/doc/demo3.png)

### 参与贡献

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