simplusinnov/turing-geolocation-report

GeoLocation-Report 微服务 Docker 镜像文档

镜像概述和主要用途

该Docker镜像用于部署GeoLocation-Report微服务，支持开发、测试和生产环境的全流程部署。通过标准化的依赖管理、容器构建和运行流程，简化微服务的开发、测试与集成，提供完整的API文档和测试验证能力。

核心功能和特性

• 依赖管理：通过package.json统一管理微服务基础依赖，无需安装全局包
• 开发支持：提供开发服务器启动脚本，便于本地开发调试
• 测试集成：支持测试用例编写与运行，测试文件集中管理
• Docker化部署：包含完整的Docker构建和运行流程，支持桥接网络链接
• 标准API端点：内置基础测试、API文档、测试状态等标准访问URL

使用场景和适用范围

适用于需要部署GeoLocation-Report微服务的开发人员和技术用户，可满足：

• 本地开发环境搭建与调试
• 测试环境功能验证
• 生产环境微服务部署与运行
• 技术用户访问API文档和测试服务

使用方法和配置说明

开发人员指南

依赖安装

所有微服务基础依赖均在package.json中定义，无需安装全局包，执行以下命令安装依赖：

bash
npm install

注意：安装额外包时，需使用--save-exact确保版本一致性，示例：

bash
npm install http-proxy --save --save-exact

启动开发服务器

bash
npm start

运行测试

测试用例需编写后添加至./test/index.ts文件进行编译，也可根据需求添加至其他测试文件。

部署指南

前提条件

部署前需满足以下要求：

• 主机服务器已安装Docker
• 已使用Docker创建桥接网络（用于微服务间链接）
• 主机服务器已安装https://gist.github.com/derhuerst/1b15ff4652a867391f03
• 已配置与项目关联的SSH密钥（确保可通过SSH执行git pull）
• （可选）npm token（如需安装@simplus依赖包）

部署步骤

1. 克隆项目
   将代码仓库克隆到主机服务器：

   bash
   git clone git@bitbucket.org:simplusinnovation/GeoLocation-Report.git
   

   若需关联本地SSH密钥，可执行：

   bash
   eval $(ssh-agent -s) && $(ssh-add /path/to/your/.ssh/id_rsa; git pull git@bitbucket.org:simplusinnovation/GeoLocation-Report.git)
   

2. 构建Docker容器
   进入项目目录并构建镜像：

   bash
   cd GeoLocation-Report
   sudo docker build -t ms:GeoLocation-Report .
   

3. 运行容器
   使用桥接网络运行容器，映射端口并设置自动重启：

   bash
   sudo docker run --network 'mynetwork' -p <hostport>:<containerport> -d --name GeoLocation-Report --restart always ms:GeoLocation-Report
   

   • <hostport>：宿主机端口
   • <containerport>：容器内部端口
   • mynetwork：预先创建的桥接网络名称

4. 测试服务
   在浏览器中访问验证服务状态：http://localhost:port/api/v1/GeoLocation-Report/

技术用户指南

微服务提供以下标准访问URL：

• http://localhost:port/api/v1/GeoLocation-Report/ - 基础测试URL
• http://localhost:port/api/v1/GeoLocation-Report/tests - 解决方案测试状态
• http://localhost:port/api/v1/GeoLocation-Report/blueprint - API蓝图文档
• http://localhost:port/api/v1/GeoLocation-Report/documentation - 代码类型文档