go-zero

环境要求

• 已安装 Go 环境，并能使用 go get / go install（GOPATH/bin 需在 $PATH 中）
• 需要安装 goctl 命令行工具，且保证其可执行并位于 $PATH 中
• 若不想本地安装 goctl，可用 Docker 运行 kevinwan/goctl 镜像
• Mac 用户可直接用 brew 安装 goctl

安装与启动步骤

1. 1获取 go-zero 依赖

   在项目目录下执行，把 go-zero 框架依赖拉取到当前项目。这是 README 给出的 Installation 命令。

   go get -u github.com/zeromicro/go-zero

   复制

2. 2安装 goctl 工具

   在 Quick Setup 与 Quick Start 中均给出该命令；安装完成后 goctl 会位于 GOPATH/bin，需确保该目录在 $PATH 中。

   go install github.com/zeromicro/go-zero/tools/goctl@latest

   复制

3. 3验证 goctl 可用

   查看版本号确认命令能正常执行。若提示 command not found，说明 GOPATH/bin 未加入 $PATH。

   goctl --version

   复制

4. 4生成 api 模板

   用 goctl 生成 greet.api 描述文件模板，随后可按 README 示例编写 Request/Response 与 service 路由。

   goctl api -o greet.api

   复制

5. 5生成 Go 服务代码

   根据 greet.api 一键生成项目骨架，包含 etc 配置、handler 路由、logic 业务逻辑、types 结构体等目录。

   goctl api go -api greet.api -dir greet

   复制

6. 6启动生成的服务

   进入 greet 目录整理依赖并运行主程序，指定 etc 下的配置文件；默认监听 8888 端口。

   cd greet
   go mod tidy
   go run greet.go -f etc/greet-api.yaml

   复制

7. 7请求验证接口

   用 curl 访问生成的 /greet/from/:name 路由，返回 HTTP/1.1 200 OK 即表示服务正常。

   curl -i http://localhost:8888/greet/from/you

   复制

关键配置

如何确认成功

运行后服务在 8888 端口监听；执行 curl -i http://localhost:8888/greet/from/you，返回 HTTP/1.1 200 OK 即启动成功。

常见问题

注意事项

• 所有命令均来自 README 的 Installation、Quick Setup 与 Quick Start 章节，未做额外扩展。
• 配置文件中的具体配置项名称以 goctl 实际生成的 etc/greet-api.yaml 内容为准，README 仅说明端口默认为 8888 且可在该文件中配置。
• 业务逻辑写在 internal/logic 包中，MySQL、Redis 等依赖通过 internal/svc/servicecontext.go 注入。
• README 还提到可参考 ai-context 与 zero-skills 集成指南配置助手工作流与模式库（需访问对应仓库页面）。