endofcake/go-todo-rest-api-example

Go Todo REST API示例镜像

这是一个Docker化的Go语言Todo应用RESTful API示例，旨在作为可部署的样本应用，演示如何将应用部署到ECS或Kubernetes等容器编排系统。该镜像包含Postgres数据库依赖，相比简单的hello-world应用更适合用于实践容器化部署流程。

本镜像基于https://github.com/mingrammer/go-todo-rest-api-example%E9%A1%B9%E7%9B%AE%E4%BF%AE%E6%94%B9%EF%BC%8C%E4%B8%BB%E8%A6%81%E5%8F%98%E6%9B%B4%E5%8C%85%E6%8B%AC%EF%BC%9A

• 将数据库引擎替换为Postgres
• 完成全流程Docker化
• 添加重试机制，确保docker-compose up可直接运行

核心功能

提供Todo应用的RESTful API接口，支持以下操作：

• 项目管理：增删改查、归档/恢复
• 任务管理：增删改查、完成/撤销完成

使用场景

1. 演示容器编排系统（如ECS、Kubernetes）的应用部署流程
2. 学习Go语言RESTful API开发与Docker化实践
3. 实践Postgres数据库与Go应用的集成

配置说明

应用需通过环境变量配置数据库连接信息：

• PGHOST：Postgres数据库主机地址
• PGDATABASE：数据库名称
• PGUSER：数据库用户名
• PGPASSWORD：数据库密码（敏感信息，建议通过安全方式管理）
• PGSSLMODE：SSL连接模式

若使用AWS参数存储管理密码，可设置PSTORE_PGPASSWORD环境变量指向参数存储中的密钥名称，镜像内置https://github.com/glassechidna/pstore%E5%B7%A5%E5%85%B7%E7%94%A8%E4%BA%8E%E8%A7%A3%E5%AF%86%EF%BC%88%E9%9C%80%E9%85%8D%E7%BD%AE%E7%9B%B8%E5%BA%94IAM%E6%9D%83%E9%99%90%EF%BC%89%E3%80%82

部署示例

本地运行

1. 克隆项目：

bash
git clone https://github.com/endofcake/go-todo-rest-api-example

2. 启动容器：

bash
docker-compose up -d

该命令会创建Postgres数据库并执行 schema 迁移，然后在3000端口启动Web服务。

3. 验证服务：

bash
# 查看所有项目（初始为空）
curl http://localhost:3000/projects

# 添加示例项目
curl -d '{"title":"sample project"}' -H "Content-Type: application/json" -X POST http://localhost:3000/projects

# 验证项目已保存
curl http://localhost:3000/projects

4. 检查数据库：

bash
export PGPASSWORD=qwerty
# 连接数据库
psql -h localhost -d todoapp -U docker
# 查看数据库结构
\d+

构建镜像

bash
cd go-todo-rest-api-example
go build
./go-todo-rest-api-example
# API端点：http://127.0.0.1:3000

项目结构

├── app
│   ├── app.go
│   ├── handler          // API核心处理逻辑
│   │   ├── common.go    // 通用响应函数
│   │   ├── projects.go  // 项目模型API
│   │   └── tasks.go     // 任务模型API
│   └── model
│       └── model.go     // 应用模型定义
├── config
│   └── config.go        // 配置文件
└── main.go

API接口列表

/projects

• GET：获取所有项目
• POST：创建新项目

/projects/:title

• GET：获取指定项目
• PUT：更新指定项目
• DELETE：删除指定项目

/projects/:title/archive

• PUT：归档指定项目
• DELETE：恢复已归档项目

/projects/:title/tasks

• GET：获取指定项目的所有任务
• POST：在指定项目中创建新任务

/projects/:title/tasks/:id

• GET：获取指定项目的指定任务
• PUT：更新指定项目的指定任务
• DELETE：删除指定项目的指定任务

/projects/:title/tasks/:id/complete

• PUT：标记指定任务为完成
• DELETE：撤销任务的完成状态