AgentSkillsCN

modelkg-gateway-routing

在新增或迁移后端接口时，及时更新 ModelKG 网关路由、Traefik 标签以及 OpenAPI 聚合配置。适用于开放新的 /api/* 路径、向 docker-compose.yml 中添加服务，或实现内部 /api/v1 路由与外部 /api 路由的映射。

SKILL.md
--- frontmatter
name: modelkg-gateway-routing
description: Update ModelKG gateway routing, Traefik labels, and OpenAPI aggregation when adding or moving backend endpoints. Use when exposing new /api/* paths, adding services to docker-compose.yml, or mapping internal /api/v1 routes to external /api routes.

ModelKG Gateway Routing

Overview

Keep gateway routing and aggregated API contracts consistent as services are added or extracted.

Workflow

  1. •Identify the target service, port, and external API prefix.
  2. •Add Traefik labels and dependencies in docker-compose.yml.
  3. •Add path rewrite middleware if the service uses /api/v1 internally.
  4. •Decide whether to add the service to OpenAPI aggregation.
  5. •Verify routes and contracts.

Routing Checklist

  • •Add a router rule for the new /api/* prefix.
  • •Set traefik.http.services.<name>.loadbalancer.server.port.
  • •Add depends_on if the service relies on Postgres/Redis/Neo4j.
  • •Add rewrite middleware for /api/v1 services.
  • •Update the API catalog aggregator if frontends need the spec.

References

  • •references/gateway-routing.md for Traefik label patterns.
  • •references/openapi-aggregation.md for contract aggregation.
  • •references/validation.md for verification steps.