scrumboxit/gateway-api

gateway-api 镜像文档

镜像概述

gateway-api是一个基于Spring Boot框架和Netflix Zuul组件构建的API网关镜像，采用Gradle作为构建工具，Kotlin作为开发语言。该镜像主要用于在微服务架构中提供统一的API入口，实现请求路由、过滤、负载均衡等核心网关功能，简化服务间通信与管理。

核心功能和特性

核心功能

• 路由转发：根据预设规则将客户端请求转发至对应的后端微服务
• 请求过滤：支持自定义过滤器，实现请求验证、日志记录、限流熔断等功能
• 负载均衡：集成服务发现机制，自动实现后端服务的负载均衡
• 统一入口：为多个微服务提供单一访问入口，简化客户端调用逻辑

技术特性

• Spring Boot：提供快速开发和自动配置能力，简化应用部署
• Netflix Zuul：成熟的API网关解决方案，支持动态路由和灵活过滤
• Gradle：高效的构建工具，支持依赖管理和自动化构建流程
• Kotlin：简洁安全的编程语言，提升开发效率和代码质量

使用场景和适用范围

适用场景

• 微服务架构：作为微服务集群的统一入口，管理服务间通信
• API请求过滤：实现身份验证、权限控制、请求日志记录等安全功能
• 跨域请求处理：统一处理不同域之间的请求跨域问题
• API版本管理：通过路由规则实现不同版本API的共存与切换
• 流量控制：集成限流、熔断机制，保护后端服务免受流量冲击

适用范围

• 中小型微服务项目
• 需要统一API管理的分布式系统
• 基于Spring Cloud生态的应用架构

使用方法和配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name gateway-api \
  -p 8080:8080 \
  -e EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://eureka-server:8761/eureka/ \
  gateway-api:latest

环境变量配置

自定义配置文件挂载

如需更复杂的路由规则或过滤器配置，可通过挂载配置文件实现：

bash
docker run -d \
  --name gateway-api \
  -p 8080:8080 \
  -v /path/to/application.yml:/app/application.yml \
  gateway-api:latest

示例application.yml配置：

yaml
server:
  port: 8080

eureka:
  client:
    serviceUrl:
      defaultZone: http://eureka-server:8761/eureka/

zuul:
  routes:
    user-service:
      path: /user/**
      serviceId: user-service
    order-service:
      path: /order/**
      serviceId: order-service
  filters:
    pre:
      - com.example.gateway.filter.AuthFilter
      - com.example.gateway.filter.LoggingFilter

Docker Compose 部署示例

yaml
version: '3'

services:
  gateway-api:
    image: gateway-api:latest
    ports:
      - "8080:8080"
    environment:
      - EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=[***]
      - ZUUL_ROUTES_USER_SERVICE_PATH=/user/**
      - ZUUL_ROUTES_USER_SERVICE_URL=[***]
    depends_on:
      - eureka-server
      - user-service
      - order-service