OpenSCRM API Server 项目教程

1. 项目目录结构及介绍

OpenSCRM API Server 项目的目录结构如下：

api-server/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── services/
│   └── utils/
├── config/
├── docs/
├── migrations/
├── public/
├── routes/
├── tests/
├── .env
├── .gitignore
├── Dockerfile
├── README.md
└── main.go

目录结构介绍

• app/: 包含应用程序的核心代码，包括控制器、模型、服务和工具类。

  • controllers/: 处理HTTP请求的控制器。
  • models/: 数据库模型定义。
  • services/: 业务逻辑服务。
  • utils/: 工具类和辅助函数。

• config/: 配置文件目录，包含应用程序的配置文件。

• docs/: 项目文档目录，包含API文档和其他相关文档。

• migrations/: 数据库迁移文件目录。

• public/: 静态文件目录，包含前端资源文件。

• routes/: 路由定义目录，包含HTTP路由配置。

• tests/: 测试文件目录，包含单元测试和集成测试。

• .env: 环境变量配置文件。

• .gitignore: Git忽略文件配置。

• Dockerfile: Docker构建文件。

• README.md: 项目说明文档。

• main.go: 项目启动文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它是整个应用程序的入口点。以下是 main.go 的主要内容：

package main

import (
    "api-server/config"
    "api-server/routes"
    "github.com/gin-gonic/gin"
)

func main() {
    // 加载配置
    config.LoadConfig()

    // 初始化Gin引擎
    r := gin.Default()

    // 注册路由
    routes.SetupRoutes(r)

    // 启动服务器
    r.Run(":8080")
}

启动文件功能介绍

• 加载配置: 通过 config.LoadConfig() 加载应用程序的配置文件。
• 初始化Gin引擎: 使用 gin.Default() 初始化Gin框架。
• 注册路由: 调用 routes.SetupRoutes(r) 注册HTTP路由。
• 启动服务器: 使用 r.Run(":8080") 启动HTTP服务器，监听8080端口。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，通常包括数据库配置、日志配置、缓存配置等。以下是一个典型的配置文件示例：

config/config.go

package config

import (
    "os"
    "github.com/joho/godotenv"
)

type Config struct {
    DBHost     string
    DBPort     string
    DBUser     string
    DBPassword string
    DBName     string
}

var Cfg Config

func LoadConfig() {
    // 加载环境变量
    err := godotenv.Load()
    if err != nil {
        panic("Error loading .env file")
    }

    // 读取配置
    Cfg = Config{
        DBHost:     os.Getenv("DB_HOST"),
        DBPort:     os.Getenv("DB_PORT"),
        DBUser:     os.Getenv("DB_USER"),
        DBPassword: os.Getenv("DB_PASSWORD"),
        DBName:     os.Getenv("DB_NAME"),
    }
}

.env

DB_HOST=localhost
DB_PORT=5432
DB_USER=user
DB_PASSWORD=password
DB_NAME=dbname

配置文件功能介绍

• config.go: 定义了配置结构体 Config，并提供了 LoadConfig 函数用于加载配置。
• .env: 环境变量文件，包含数据库连接信息等敏感配置。

通过以上配置文件，项目可以在不同的环境中灵活配置，确保应用程序的稳定运行。