工程开发
go-api avatar

go-api

建立生产级 Go API 服务,包含可观测性、本地开发环境与整洁架构的样板代码。

简介

go-api 技能是一个自动化的架构支架,专为需要快速引导生产级微服务的 Go 开发人员所设计。它强制执行行业标准的项目结构,包括严格分离 HTTP 处理程序、业务逻辑服务与数据存储库的整洁架构模式。通过自动化建立项目层次结构,确保分布式系统间的一致性,并减少初始样板设置的时间。

  • 产生完整的项目目录结构,包含 cmd、internal、docs、local 与 scripts 文件夹。

  • 整合关键的可观测性堆栈,为 Prometheus、Grafana、Tempo 与 Loki 提供预先配置的 docker-compose 设置。

  • 实作标准 Go 模式,例如使用 slog 进行结构化记录、上下文传播、使用 OpenTelemetry 进行追踪,以及标准化的错误处理。

  • 配置强健的 HTTP 中间件管线,并包含 MySQL 数据库与 Redis 缓存的模板文件。

  • 通过产生的 Makefile 支持自动化项目生命周期任务,涵盖构建、Linting、单元测试与集成测试工作流程。

  • 强制执行严格的包命名约定(例如使用 x 后缀来遮蔽标准库),以维持代码库的可读性。

  • 目标用户:构建 Go 微服务的软件工程师、后端开发人员与 DevOps 从业人员。

  • 使用方式:在初始化新存储库或服务时调用此技能;代理程序将提示输入所需的服务名称(使用 kebab-case)与模块路径。

  • 输入:需要服务名称(例如 user-service)与 Go 模块路径(例如 github.com/myorg/myservice)。

  • 限制:产生的代码需要已安装 Docker 的 Go 环境以供本地基础设施使用;适用于采用结构化、测试驱动开发 (TDD) 方法的项目。

仓库统计

Star 数
2
Fork 数
0
Open Issue 数
0
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 21:07
在 GitHub 查看