ebsproject/sm-api

服务管理栈API容器

镜像概述

本镜像为服务管理栈（Service Management stack）的API容器，作为服务管理功能的接口层，提供标准化的API接口，支持服务注册、发现、配置、监控等管理操作的调用与集成，是服务管理栈的核心组件之一。

核心功能与特性

1. 标准化API接口

• 提供RESTful风格API接口，支持服务管理全流程操作
• 接口遵循OpenAPI规范，便于文档生成与客户端集成

2. 服务生命周期管理

• 支持服务注册、注销、状态更新等基础操作
• 提供服务元数据查询、配置信息获取接口

3. 组件集成能力

• 与服务管理栈其他组件（如数据库、服务注册中心、监控系统）无缝集成
• 支持自定义插件扩展，满足特定业务场景需求

4. 安全与可靠性

• 内置接口权限控制机制，支持API密钥认证
• 实现请求限流与熔断保护，保障服务稳定性

使用场景与适用范围

适用场景

• 企业级服务管理系统的API接口层
• 微服务架构中的服务治理与管控平台
• 服务监控、配置管理平台的后端API服务
• 第三方系统集成服务管理功能的接口服务

适用范围

• 中大型分布式系统的服务管理场景
• 需要标准化API接口的服务治理需求
• 服务管理栈组件化部署环境

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name service-management-api \
  -p 8080:8080 \
  -e API_PORT=8080 \
  -e DB_HOST=service-mgmt-db \
  -e REGISTRY_URL=http://service-registry:8500 \
  [镜像名称]:[版本标签]

Docker Compose配置示例

yaml
version: '3'
services:
  api:
    image: [镜像名称]:[版本标签]
    container_name: service-management-api
    ports:
      - "8080:8080"
    environment:
      - API_PORT=8080
      - DB_HOST=service-mgmt-db
      - DB_PORT=5432
      - REGISTRY_URL=http://service-registry:8500
      - LOG_LEVEL=info
    depends_on:
      - service-mgmt-db
      - service-registry
    networks:
      - service-mgmt-network

networks:
  service-mgmt-network:
    driver: bridge

环境变量配置

端口映射说明

• 容器内部默认监听端口：8080（可通过API_PORT调整）
• 建议宿主机映射端口与容器端口保持一致，便于管理

数据持久化

若需持久化API配置文件，可通过数据卷挂载配置目录：

bash
docker run -d \
  --name service-management-api \
  -p 8080:8080 \
  -v /host/path/to/config:/app/config \
  [镜像名称]:[版本标签]

注意事项

• 需确保与服务管理栈其他组件（数据库、注册中心等）网络互通
• 生产环境中建议启用AUTH_ENABLED并配置强密钥
• 高并发场景下可通过水平扩展多个API容器实例实现负载均衡