gamussa/reactive-quote-service

quotes-service Docker 镜像文档

镜像概述

quotes-service 是一个轻量级 RESTful API 服务，基于 Node.js 开发，核心功能是提供随机名言警句的获取接口。该服务支持通过环境变量配置运行参数，可自定义名言数据源，便于快速集成到各类应用中。

核心功能与特性

• RESTful API 接口：提供简洁的 HTTP 接口，支持获取随机名言
• 自定义名言库：支持通过文件或环境变量指定自定义名言集合
• 灵活配置：通过环境变量配置服务端口、数据源路径等参数
• 轻量级部署：基于 Node.js 构建，镜像体积小，启动速度快
• 跨平台兼容：支持 Docker 容器化部署，可在任意支持 Docker 的环境运行

使用场景与适用范围

• 开发测试：为前端或后端开发提供模拟数据接口，验证 API 调用逻辑
• 学习项目：作为 Node.js/RESTful API 学习案例，了解服务构建与容器化部署
• 应用点缀：为网站、小程序、桌面应用等提供随机名言展示功能
• 教学演示：在编程教学中作为简单后端服务示例，演示接口调用与配置

使用方法与配置说明

基本部署（docker run）

通过以下命令快速启动服务：

bash
docker run -d -p 3000:3000 --name quotes-service gamussa/quotes-service

环境变量配置

服务支持通过环境变量自定义运行参数，常用参数如下：

示例：指定端口为 8080 并使用自定义名言文件

bash
docker run -d \
  -p 8080:8080 \
  -e PORT=8080 \
  -v /local/path/quotes.json:/app/custom-quotes.json \
  -e QUOTE_FILE=/app/custom-quotes.json \
  --name quotes-service gamussa/quotes-service

Docker Compose 配置

创建 docker-compose.yml 文件进行编排部署：

yaml
version: '3'
services:
  quotes-service:
    image: gamussa/quotes-service
    ports:
      - "3000:3000"
    environment:
      - PORT=3000
      - CORS_ENABLED=true
    volumes:
      - ./custom-quotes.json:/app/quotes.json  # 挂载自定义名言文件
    restart: unless-stopped

启动命令：

bash
docker-compose up -d

API 接口说明

服务启动后，通过以下接口获取名言：

获取随机名言

• 请求方法：GET
• 端点：/api/quote
• 响应示例：

  json
  {
    "quote": "生命不是要等待暴风雨过去，而是要学会在雨中起舞。",
    "author": "佚名"
  }
  

获取名言列表（全部）

• 请求方法：GET
• 端点：/api/quotes
• 响应示例：

  json
  [
    {
      "quote": "生命不是要等待暴风雨过去，而是要学会在雨中起舞。",
      "author": "佚名"
    },
    {
      "quote": "千里之行，始于足下。",
      "author": "老子"
    }
  ]
  

自定义名言库

1. 本地创建 quotes.json 文件，格式如下：

   json
   [
     {"quote": "自定义名言1", "author": "作者A"},
     {"quote": "自定义名言2", "author": "作者B"}
   ]
   

2. 通过 -v 参数挂载文件到容器内（如上文 docker run 示例）

注意事项

• 自定义名言文件需符合 JSON 格式，否则服务启动可能失败
• 若需持久化自定义名言库，建议通过 Docker 数据卷（Volume）挂载文件
• 生产环境建议设置 CORS_ENABLED=false 并配合反向代理使用，增强安全性