» Go:使用Gin构建REST API » 2. 开发 » 2.1 初始版本

初始版本

创建模块

执行 go mod init 命令,指定模块路径。

go mod init literank.com/rest-books

其结果:

go: creating new go.mod: module literank.com/rest-books

该命令会创建一个 go.mod 文件,其用于追踪管理项目依赖。

安装依赖框架

安装 Gin 框架:

go get -u github.com/gin-gonic/gin

该命令会更新 go.mod 文件并在项目中自动创建一个 go.sum 文件。

创建 main.go:

package main

import "github.com/gin-gonic/gin"

func main() {
	// 创建一个新的 Gin 路由设置器 router
	r := gin.Default()
	// 定义一个 GET 处理器 handler
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	// 运行服务器,默认端口 8080
	r.Run()
}

如下运行程序:

go run main.go

将得到类似如下信息:

[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /ping                     --> main.main.func1 (3 handlers)
[GIN-debug] [WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.
Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all-proxies for details.
[GIN-debug] Environment variable PORT is undefined. Using port :8080 by default
[GIN-debug] Listening and serving HTTP on :8080

你的 API 服务器已经在 8080 端口跑起来了。

尝试使用 curl 命令测试 /ping 端点:

curl http://localhost:8080/ping

结果显示:

{"message":"pong"}

不错!你的服务器运作起来了。