rstropek/node-mongo-sample

Node + MongoDB示例镜像

镜像概述

本示例镜像实现了一个用于事件和参与者管理的简单RESTful Web API，基于Node.js开发并使用MongoDB存储数据，主要用于Docker和Kubernetes培训场景。

核心功能

1. 提供事件创建、参与者注册及签到等事件与参与者管理的REST接口
2. 包含Swagger（v2）和OpenAPI（v3）规范文件，支持相关技术教学
3. 可通过环境变量配置MongoDB连接地址

使用场景

• Docker和Kubernetes培训中的示例应用部署演示
• OpenAPI/Swagger规范的教学与实践场景

配置说明

• 环境变量：MONGO_URL需指定MongoDB连接地址，格式为mongodb://[主机名]/[数据库名]

快速启动

步骤1：拉取镜像

sh
docker pull rstropek/node-mongo-sample

步骤2：启动MongoDB容器（若未部署）

sh
docker run --name event-db -d mongo

步骤3：启动Web API容器

sh
docker run -e MONGO_URL=mongodb://event-db/member-management --link event-db -p 1337:80 -d --name event-api rstropek/node-mongo-sample

步骤4：测试API

可尝试以下示例请求：

txt
GET http://localhost:1337/api/events?past=true
Accept: application/json

###
POST http://localhost:1337/api/events
Content-Type: application/json
Accept: application/json

{
    "date": "2018-03-21T00:00:00",
    "location": "Linz"
}

###
POST http://localhost:1337/api/events/5ab1f7783907dc5490a62a26/registrations
Content-Type: application/json
Accept: application/json

{
    "participant": 
    {
        "givenName": "John",
        "familyName": "Doe"
    }
}

###
GET http://localhost:1337/api/events/5ab1f7783907dc5490a62a26/registrations
Accept: application/json

###
POST http://localhost:1337/api/participants/5ab1f82465ab325e8356f183/checkin/5ab1f7783907dc5490a62a26
Content-Type: application/json
Accept: application/json