go-gin-api 项目教程

1. 项目的目录结构及介绍

go-gin-api 项目的目录结构如下：

go-gin-api/
├── api
│   ├── controller
│   ├── middleware
│   ├── router
│   └── service
├── cmd
│   └── server
├── config
├── docs
├── internal
│   ├── app
│   ├── pkg
│   └── utils
├── migrations
├── scripts
├── storage
├── test
└── web

目录介绍

• api: 包含控制器、中间件、路由和服务等API相关代码。
  • controller: 处理HTTP请求的控制器。
  • middleware: 中间件，用于处理请求前后的逻辑。
  • router: 定义API路由。
  • service: 业务逻辑层。
• cmd: 包含项目的启动文件。
  • server: 启动服务器的主文件。
• config: 配置文件目录。
• docs: 项目文档。
• internal: 内部包，包含应用、包和工具类。
  • app: 应用相关代码。
  • pkg: 内部包。
  • utils: 工具类。
• migrations: 数据库迁移文件。
• scripts: 脚本文件。
• storage: 存储文件。
• test: 测试文件。
• web: 前端资源文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/server/main.go。该文件是整个应用的入口点，负责初始化配置、启动服务器等。

package main

import (
    "github.com/xinliangnote/go-gin-api/internal/app/server"
)

func main() {
    server.Run()
}

启动文件功能

• 初始化配置: 读取配置文件并初始化应用配置。
• 启动服务器: 启动HTTP服务器，监听指定端口。

3. 项目的配置文件介绍

配置文件位于 config 目录下，通常包括 app.yaml 或 app.json 等格式。

配置文件示例

app:
  name: go-gin-api
  port: 8080

database:
  host: localhost
  port: 3306
  user: root
  password: password
  name: go_gin_api

log:
  level: info
  path: /var/log/go-gin-api

配置项介绍

• app: 应用配置。
  • name: 应用名称。
  • port: 服务器监听端口。
• database: 数据库配置。
  • host: 数据库主机。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• log: 日志配置。
  • level: 日志级别。
  • path: 日志文件路径。

以上是 go-gin-api 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。