klerith/pokemon-nest-app

Pokemon REST API 练习镜像

镜像概述

本镜像为Docker学习练习项目，基于Nest.js框架和MongoDB构建，提供Pokemon数据的RESTful接口，用于实践Docker部署与Nest.js整合数据库的开发流程。

核心功能

1. 初始化种子数据：通过API接口加载初始Pokemon数据
2. 查询Pokemon列表：支持分页参数（limit、offset）获取Pokemon数据

使用场景

• Docker部署学习与实践
• Nest.js框架与MongoDB整合开发练习
• REST API接口设计与测试练习

配置说明

需设置以下环境变量：

• MONGODB：MongoDB服务连接地址（如 mongodb://mongo_service:27017）
• DB_NAME：数据库名称（推荐使用 poke_db）

部署示例

Docker Run 命令

bash
docker run -d \
  -p 3000:3000 \
  -e MONGODB=mongodb://your-mongo-host:27017 \
  -e DB_NAME=poke_db \
  docker.xuanyuan.run/klerith/pokemon-nest-app

Docker Compose 示例（含MongoDB服务）

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  app:
    image: docker.xuanyuan.run/klerith/pokemon-nest-app
    ports:
      - "3000:3000"
    environment:
      - MONGODB=mongodb://mongo:27017
      - DB_NAME=poke_db
    depends_on:
      - mongo
  mongo:
    image: docker.xuanyuan.run/mongo:latest
    ports:
      - "27017:27017"

执行部署：docker-compose up -d

API 接口使用

1. 加载初始种子数据：访问 http://localhost:3000/api/v2/seed
2. 查询Pokemon列表：访问 http://localhost:3000/api/v2/pokemon?limit=20&offset=40（可调整limit和offset参数）