socialcomputing/elas-official-backend-2-api-gateway

ELAS API网关服务镜像文档

概述

本镜像为"Exploratory Learning Analytics toolkit for Students"（ELAS）项目的后端API网关服务（backend/2-api-gateway），是ELAS技术架构中的核心组件。ELAS项目旨在为杜伊斯堡-埃森大学学生提供学习分析工具平台，集成了社会计算小组开设的学习分析、高级Web技术等课程中学生项目开发的各类学习分析应用。API网关作为前端与后端微服务的中间层，负责请求路由、服务注册与发现、以及各后端服务的集成协调。

核心功能

• 请求路由：接收前端请求并路由至相应的后端微服务
• 服务集成：连接服务注册中心与各后端服务（如认证服务、学习分析应用服务等）
• 通信协调：处理跨服务通信，确保前端与后端服务间的数据交互
• 环境适配：支持开发、预览及生产环境的部署配置

使用场景

• ELAS平台开发环境的本地部署
• ELAS平台测试环境的服务集成
• ELAS平台生产环境的请求流量管理

使用方法

Docker部署

快速启动

通过Docker Compose一键部署整个ELAS平台（包含API网关服务）：

bash
docker compose up

环境配置

API网关服务依赖以下环境变量配置，需在部署前设置：

• SERVICE_REGISTRY_URL：服务注册中心地址（如http://localhost:8761/eureka/）
• HOST：网关服务绑定的主机地址（默认localhost）

可通过项目根目录下的.env文件或Docker Compose配置文件设置上述变量。

开发环境设置

依赖安装

1. 前置软件要求：

   • OpenJDK 21
   • Maven（最新版）
   • Git

2. 获取源码：

   bash
   git clone https://github.com/ude-soco/elas-official.git
   cd elas-official/backend/2-api-gateway
   

3. 构建项目：

   bash
   mvn clean package
   

启动服务

1. 配置环境变量：

   cmd
   set SERVICE_REGISTRY_URL=http://localhost:8761/eureka/
   set HOST=localhost
   

2. 启动API网关：

   bash
   java -jar target/ApiGateway.jar
   

服务启动后，默认监听由服务注册中心分配的端口，可通过前端或API测试工具（如Postman）访问。

技术架构

API网关服务是ELAS技术架构的关键中间层，连接前端应用与后端微服务（如认证服务、E3Selector服务、StudyCompass服务等），通过服务注册中心（Spring Boot Service Registry）实现服务发现与动态路由，确保整个平台的服务协同与数据交互。

相关资源

• 生产环境实例：elas-official.soco.inko.cloud
• 预览环境实例：edge.elas-official.soco.inko.cloud
• 项目源码：https://github.com/ude-soco/elas-official