SIVIS API网关镜像文档

概述

SIVIS API网关是一款面向微服务架构的API管理工具，作为客户端与后端服务间的中间层，负责API请求的统一接入、路由转发、安全认证及流量治理，旨在简化分布式系统中的接口通信管理，提升服务架构的可扩展性与安全性。

核心功能与特性

API路由与转发

• 支持基于路径、域名、请求方法的灵活路由规则配置
• 实现请求的智能转发，将客户端请求路由至对应的后端服务实例
• 支持服务发现集成，动态获取后端服务地址（如对接Consul、Eureka等注册中心）

安全认证与授权

• 集成多种认证机制（JWT、OAuth2.0、API Key等）
• 支持细粒度权限控制，基于角色或资源的访问策略配置
• 提供请求签名验证，防止非法请求伪造

流量治理

• 实现请求限流（基于QPS、并发数），保护后端服务免受流量冲击
• 支持熔断与降级机制，当后端服务异常时自动切换故障处理策略
• 提供请求重试与超时控制，提升系统容错能力

监控与可观测性

• 内置请求 metrics 采集，支持对接Prometheus等监控系统
• 提供详细的访问日志记录，包含请求路径、耗时、状态码等关键信息
• 支持分布式追踪集成（如Jaeger、Zipkin），便于问题排查

使用场景

微服务架构API统一入口

作为微服务集群的"前门"，统一接收客户端请求并转发至对应服务，简化客户端与后端服务的直接通信复杂度。

跨服务通信管理

在多团队协作的微服务环境中，通过网关实现服务间调用的权限控制、流量限制与通信规范统一。

第三方API接入控制

对接外部第三方服务时，通过网关进行请求验证、参数转换与安全隔离，降低直接集成风险。

API版本与生命周期管理

支持API多版本共存，通过路由规则实现版本平滑切换，便于API迭代与兼容性管理。

使用方法

基本运行命令

docker run -d \
  --name sivis-api-gateway \
  -p 8080:8080 \
  -v /path/to/config:/etc/sivis-gateway \
  sivis/api-gateway:latest

环境变量配置

配置文件挂载

网关核心配置通过外部配置文件（如gateway.yml）定义，需挂载至容器内/etc/sivis-gateway目录，示例配置片段：

routes:
  - id: user-service
    uri: lb://user-service  # 基于服务发现的路由
    predicates:
      - Path=/api/v1/users/**
    filters:
      - name: RequestRateLimiter
        args:
          redis-rate-limiter.replenishRate: 10
          redis-rate-limiter.burstCapacity: 20
      - name: AuthenticationFilter
        args:
          auth-type: jwt
          jwt-secret: your-jwt-secret-key

健康检查

网关内置健康检查接口，可通过http://localhost:8080/actuator/health查看服务状态。

注意事项

• 生产环境建议配合外部配置中心（如Nacos、Apollo）管理动态配置
• 高可用部署时需部署多个实例并配合负载均衡器（如Nginx、云负载均衡）
• 对于敏感配置（如密钥、数据库密码），建议通过容器 secrets 或环境变量加密传递