Newbee Mall API Go 项目教程
1. 项目的目录结构及介绍
Newbee Mall API Go 项目的目录结构如下:
newbee-mall-api-go/
├── api
│ ├── goods.go
│ ├── order.go
│ ├── user.go
│ └── ...
├── config
│ ├── app.ini
│ └── ...
├── docs
│ ├── README.md
│ └── ...
├── middleware
│ ├── auth.go
│ └── ...
├── models
│ ├── goods.go
│ ├── order.go
│ ├── user.go
│ └── ...
├── routers
│ ├── router.go
│ └── ...
├── service
│ ├── goods.go
│ ├── order.go
│ ├── user.go
│ └── ...
├── utils
│ ├── common.go
│ └── ...
├── go.mod
├── go.sum
└── main.go
目录结构介绍
- api: 包含处理HTTP请求的控制器文件。
- config: 包含项目的配置文件。
- docs: 包含项目的文档文件。
- middleware: 包含中间件文件,如身份验证中间件。
- models: 包含数据模型文件。
- routers: 包含路由配置文件。
- service: 包含业务逻辑处理文件。
- utils: 包含工具函数文件。
- go.mod 和 go.sum: Go模块文件,用于管理依赖。
- main.go: 项目的入口文件。
2. 项目的启动文件介绍
项目的启动文件是 main.go
,其主要功能是初始化配置、设置路由和启动HTTP服务器。以下是 main.go
的简要介绍:
package main
import (
"newbee-mall-api-go/config"
"newbee-mall-api-go/routers"
"github.com/gin-gonic/gin"
)
func main() {
// 初始化配置
config.Init()
// 创建Gin引擎
r := gin.Default()
// 设置路由
routers.SetupRouter(r)
// 启动HTTP服务器
r.Run(":8080")
}
启动文件功能
- 初始化配置: 加载配置文件,设置应用的基本配置。
- 创建Gin引擎: 使用Gin框架创建HTTP服务器。
- 设置路由: 配置API路由。
- 启动HTTP服务器: 在指定端口(如8080)启动HTTP服务器。
3. 项目的配置文件介绍
项目的配置文件位于 config
目录下,主要文件是 app.ini
。以下是 app.ini
的简要介绍:
[app]
RunMode = debug
HttpPort = 8080
[database]
Type = mysql
User = root
Password = 123456
Host = 127.0.0.1:3306
Name = newbee_mall
TablePrefix = newbee_
配置文件内容
- app: 应用的基本配置,如运行模式和HTTP端口。
- database: 数据库配置,包括数据库类型、用户名、密码、主机地址、数据库名称和表前缀。
通过这些配置,项目可以灵活地适应不同的运行环境和数据库设置。