# echoapi

**Repository Path**: supower/echoapi

## Basic Information

- **Project Name**: echoapi
- **Description**: go语言api服务：echo4+gorm2
- **Primary Language**: Go
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/supower/echoapi
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-02-10
- **Last Updated**: 2022-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# echoapi

#### 介绍
简单的go语言api服务：echo4+gorm2

https://gitee.com/supower/echoapi

持续更新中......期待您的加入!

#### 软件架构
软件架构说明

>Echo4框架官网文档：https://echo.labstack.com/middleware

>gorm2中文文档：https://www.bookstack.cn/read/gorm-2.0/index.md


#### 安装教程

1.  将代码下载到GOPATH目录的src包下(最外层echoapi包名建议不要更改，改的话记得改相应文件import的路径)
2.  go mod安装即可

#### 使用说明

1.  运行：go run server.go

    运行成功后若未装数据库可以调用localhost:8086/user/name来验证echo4是否好用

    ![输入图片说明](%E5%9B%BE%E7%89%87.png)
    
    用户参数验证可以使用echo4的JWT，详见Echo4官方文档（由于懒且暂时没用到就还未做）
2.  打包：go build server.go
    在windows下打包成linux服务器执行文件：
    ```sh
	用cmd打开server.go所在目录
	set GOARCH=amd64 
	set GOOS=linux 
	然后再 go build server.go 得到一个 server 文件
	将 server 文件放到服务器并更改权限为可执行
	然后 ./server 运行
    服务器nginx配置
	location ^~/rsstatic/ {
		alias /app/upload/;
	}
	location /rsapi/ {
		proxy_set_header Host $http_host;
		proxy_set_header X-Forward-For $remote_addr;
		proxy_pass http://127.0.0.1:8086/;
	}
    ```
#### 目录结构规范说明
```sh
config          配置文件包
controller      控制层与业务逻辑，公共入口controller.go
libs            放一些第三方工具
  └ dbmysql     gorm2链接mysql的公共包
middle          中间件
model           数据库模型
utils           自己写的一些工具包
```

#### 参与贡献

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


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)