[G1-Sync] Manual knowledge update
This commit is contained in:
@@ -2,121 +2,186 @@
|
||||
id: wiki-2026-0508-api-gateway
|
||||
title: API Gateway
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-REINFORCE-WIKI-80E2D2FE]
|
||||
aliases: [API GW, Gateway pattern, Edge service]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.95
|
||||
tags: [api-gateway, 마이크로서비스-아키텍처-(microservices-architecture), 서버리스-아키텍처-(serverless-architecture), 서비스-메시-(service-mesh), 레거시-시스템-현대화-(legacy-system-modernization), architecture-principles]
|
||||
confidence_score: 0.9
|
||||
verification_status: applied
|
||||
tags: [architecture, microservices, api, gateway, edge]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-02
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: yaml
|
||||
framework: Kong, AWS API Gateway, Envoy
|
||||
---
|
||||
|
||||
# [[API Gateway]]
|
||||
# API Gateway
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
API Gateway는 클라이언트와 마이크로서비스(또는 서버리스 함수) 사이에서 중개자 역할을 수행하는 관리 도구이자 핵심 아키텍처 패턴입니다 [1, 2]. 클라이언트의 API 요청을 접수하여 적절한 백엔드 마이크로서비스로 전달(Forward)하고, 그 결과를 모아 다시 클라이언트에게 반환하는 애플리케이션의 주 진입점(Entry point) 역할을 수행합니다 [2, 3]. 이를 통해 클라이언트에게 일관된 인터페이스를 제공하며 기반 아키텍처의 복잡성을 추상화합니다 [4].
|
||||
## 매 한 줄
|
||||
> **"매 single entry point — fan-out, auth, rate limit"**. 매 microservices 의 클라이언트 facing facade. 매 Netflix Zuul (2013) 시작 → Kong (2015) → Envoy/Istio (2017) → AWS API Gateway HTTP API (2019). 매 2026 modern stack 은 Envoy + xDS control plane, edge AI inference gateway (LiteLLM, Portkey) 의 추가.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
- **단일 진입점 및 라우팅 (Entry Point & Routing):** 마이크로서비스 아키텍처에서 API Gateway는 클라이언트가 내부 서비스에 접근하는 방식을 정의하는 주 진입점으로 사용됩니다 [1, 3]. 클라이언트의 요청을 받아 올바른 마이크로서비스로 라우팅하고, 응답을 수신하여 클라이언트에게 반환하는 중개자 역할을 합니다 [2].
|
||||
- **아키텍처 추상화 및 일관성 (Abstraction & Consistency):** 기존 모놀리식 아키텍처에서 서버리스나 마이크로서비스 기반으로 마이그레이션할 때, 기반 아키텍처의 복잡성을 숨기고 클라이언트에게 일관된 인터페이스를 제공하는 전략적 수단으로 사용됩니다 [4].
|
||||
- **서버리스 및 이벤트 기반 워크로드 통합 (Serverless & Event-Driven Integration):** AWS Lambda와 같은 클라우드 서비스와 결합되어 서버리스 아키텍처를 구성하는 데 활용되며 [5], 데이터 스트림 처리, 실시간 분석과 같은 이벤트 기반 워크로드(Event-driven workloads)를 처리하는 데 탁월한 역할을 수행합니다 [6].
|
||||
- **보안 및 관리 도구 (Security & Management Tool):** API Gateway 자체는 마이크로서비스가 아니며, 백엔드 서비스들을 운영하고 관리하는 도구입니다 [2]. 서버리스 및 분산 환경에서는 각 컴포넌트별 권한(Permissions) 제어 및 환경 변수 관리를 세심하게 수행하는 지점이 됩니다 [7].
|
||||
## 매 핵심
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **기술 스택의 비대화 및 비용 증가 (Fatter Technology Stack & Cost):** API Gateway를 도입하면 오케스트레이터, 서버 클러스터, 서비스 메시 등과 함께 전체 기술 스택이 두꺼워지며(Fatter technology stack) 더 많은 리소스를 요구하게 됩니다 [8]. 이는 마이크로서비스 기반 소프트웨어 개발 프로젝트의 전체적인 클라우드 리소스 및 인프라 비용을 증가시키는 원인이 됩니다 [9].
|
||||
- **관리의 복잡성 (Management Complexity):** 서버리스 환경에서 API Gateway를 활용할 때 각 컴포넌트(함수)에 대한 권한 및 환경 변수를 세밀하게 관리해야 하는 운영 상의 복잡성이 수반됩니다 [7]. 또한, 백엔드의 마이크로서비스들과 명확하게 연결되어야만 제 기능을 하므로 설계 및 구성 과정에서 추가적인 노력이 필요합니다 [2].
|
||||
### 매 책임
|
||||
- **Routing**: path/host/header → upstream service.
|
||||
- **Auth/AuthZ**: JWT validation, OAuth2 introspection, mTLS termination.
|
||||
- **Rate limiting**: per-key, per-IP, sliding window.
|
||||
- **Observability**: trace propagation (W3C Trace Context), metrics, access log.
|
||||
- **Transformation**: request/response shaping, protocol translation (REST↔gRPC).
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
### Related Concepts
|
||||
### 매 NOT 책임
|
||||
- Business logic — 매 service 의 책임.
|
||||
- Data persistence — 매 stateless edge.
|
||||
- Heavy aggregation — 매 BFF (Backend-for-Frontend) layer 의 책임.
|
||||
|
||||
#### [관계 유형 A (아키텍처/기반 기술)]
|
||||
- [[마이크로서비스 아키텍처 (Microservices Architecture)]]
|
||||
- 연결 이유: API Gateway는 마이크로서비스 아키텍처에서 클라이언트가 수많은 독립적인 서비스에 접근하기 위해 반드시 필요한 진입점(Entry point) 패턴으로 설계됩니다 [1, 3].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 분산된 시스템 환경에서 개별 서비스의 복잡성을 캡슐화하고 클라이언트 통신을 중개해야 하는 구조적 당위성을 이해할 수 있습니다 [2].
|
||||
- [[서버리스 아키텍처 (Serverless Architecture)]]
|
||||
- 연결 이유: AWS Lambda와 같은 서버리스 함수들을 클라이언트에 노출시키고 이벤트 기반 워크로드를 관리하기 위해 API Gateway가 핵심 인프라로 결합되어 사용됩니다 [5, 6].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 인프라 관리 없이 함수 단위로 코드를 실행하는 환경에서 요청을 어떻게 수신하고 라우팅하는지 파악할 수 있습니다 [4, 10].
|
||||
### 매 응용
|
||||
1. **Public API edge** — Stripe, Twilio 형 SaaS API.
|
||||
2. **BFF per client** — mobile/web/CLI 매 다른 shape.
|
||||
3. **LLM gateway** — multi-provider routing (Claude, GPT, local), fallback, cost cap.
|
||||
|
||||
#### [관계 유형 B (구현/운영 요소)]
|
||||
- [[서비스 메시 (Service Mesh)]]
|
||||
- 연결 이유: API Gateway와 함께 분산 애플리케이션의 통신, 운영 및 관리를 돕는 도구로 함께 언급되며, 마이크로서비스 환경에서 기술 스택을 두껍게 만드는 주요 요소로 꼽힙니다 [8, 11].
|
||||
- 이 개념을 통해 더 깊게 이해할 수 있는 부분: 외부 클라이언트와의 통신을 제어하는 API Gateway와 시스템 내부 마이크로서비스 간의 통신을 제어하는 서비스 메시의 역할 차이 및 상호 보완적인 관계를 이해할 수 있습니다 [2, 11].
|
||||
## 💻 패턴
|
||||
|
||||
### Deeper Research Questions
|
||||
- 모놀리식 아키텍처에서 서버리스 아키텍처로 마이그레이션할 때 API Gateway를 활용하여 점진적으로 시스템을 교체하는 구체적인 원리는 무엇인가? [4, 12]
|
||||
- API Gateway가 클라이언트 요청을 다수의 마이크로서비스로 라우팅할 때 발생할 수 있는 단일 장애점(Single Point of Failure) 문제나 성능 병목 현상은 어떻게 설계적으로 완화할 수 있는가? [2]
|
||||
- API Gateway와 서비스 메시(Service Mesh)는 마이크로서비스 통신 관리 측면에서 어떻게 역할이 명확히 구분되며, 어떤 규모의 시스템에서 결합하여 사용해야 하는가? [2, 8, 11]
|
||||
- 서버리스 아키텍처에서 API Gateway를 통한 이벤트 기반 워크로드 처리 시, 권한 관리와 환경 변수 구성의 복잡성을 최소화하기 위한 아키텍처적 파이프라인이나 접근법은 무엇인가? [6, 7]
|
||||
- API Gateway를 통과하는 트래픽을 관측(Observability)하고 디버깅하기 위해 분산 시스템의 로깅 및 추적 설계는 어떻게 구성되어야 하는가? [13, 14]
|
||||
|
||||
### Practical Application Contexts
|
||||
- **Implementation:** AWS API Gateway와 같은 클라우드 관리 도구를 사용하여 클라이언트 요청을 백엔드 서버리스 함수로 전달함으로써 Slack과 같은 애플리케이션의 실시간 통신 및 통합 기능을 구현합니다 [5, 6].
|
||||
- **System Design:** 다수의 마이크로서비스로 구성된 이커머스 애플리케이션(예: StoreFrontUI)에서 클라이언트가 내부 서비스 로직에 직접 접근하지 못하도록 일관된 인터페이스를 제공하는 주 진입점(Entry point)으로 설계합니다 [3, 4, 15].
|
||||
- **Operation / Maintenance:** 개별 마이크로서비스 및 서버리스 컴포넌트의 권한 및 환경 설정을 중앙 집중식으로 관리하며 [7], 레거시 모놀리식 시스템을 분산 아키텍처로 마이그레이션할 때 요청 경로를 제어하여 무중단 전환을 지원합니다 [4].
|
||||
- **Learning Path:** 모놀리식 아키텍처와 마이크로서비스 및 서버리스 아키텍처의 차이를 학습한 후, 분산 시스템 환경에서 외부 클라이언트와 통신을 제어하고 시스템 결합도를 낮추는 아키텍처 패턴을 이해하는 과정으로 활용됩니다 [1, 2].
|
||||
- **My Project Relevance:** 소스에 관련 정보가 부족합니다. (제공된 소스 데이터에는 사용자의 특정 프로젝트 구현 맥락에 대한 정보가 존재하지 않습니다.)
|
||||
|
||||
### Adjacent Topics
|
||||
- [[레거시 시스템 현대화 (Legacy System Modernization)]]
|
||||
- 확장 방향: 모놀리식 아키텍처에서 서버리스나 마이크로서비스 구조로 전환 시, API Gateway를 활용해 점진적으로 아키텍처를 교체하고 구형 시스템과 신형 시스템 간의 라우팅을 추상화하는 기법을 탐구합니다 [4].
|
||||
- [[이벤트 기반 아키텍처 (Event-Driven Architecture)]]
|
||||
- 확장 방향: API Gateway가 실시간 분석이나 데이터 스트리밍과 같은 이벤트 기반 워크로드를 어떻게 트리거하고 수용하는지 그 비동기적 통신 구조의 설계 방식을 분석합니다 [6].
|
||||
|
||||
---
|
||||
*Last updated: 2026-05-02*
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
### Kong declarative config
|
||||
```yaml
|
||||
_format_version: "3.0"
|
||||
services:
|
||||
- name: orders-api
|
||||
url: http://orders.svc.cluster.local:8080
|
||||
routes:
|
||||
- name: orders-route
|
||||
paths: ["/api/orders"]
|
||||
strip_path: false
|
||||
plugins:
|
||||
- name: rate-limiting
|
||||
config: { minute: 600, policy: redis }
|
||||
- name: jwt
|
||||
config: { key_claim_name: kid }
|
||||
- name: prometheus
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Envoy route config
|
||||
```yaml
|
||||
route_config:
|
||||
virtual_hosts:
|
||||
- name: api
|
||||
domains: ["api.example.com"]
|
||||
routes:
|
||||
- match: { prefix: "/v1/orders" }
|
||||
route:
|
||||
cluster: orders_cluster
|
||||
timeout: 5s
|
||||
retry_policy:
|
||||
retry_on: 5xx,reset,connect-failure
|
||||
num_retries: 2
|
||||
per_try_timeout: 1s
|
||||
```
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### AWS API Gateway HTTP API + Lambda authorizer
|
||||
```yaml
|
||||
# SAM template
|
||||
HttpApi:
|
||||
Type: AWS::Serverless::HttpApi
|
||||
Properties:
|
||||
Auth:
|
||||
Authorizers:
|
||||
JwtAuth:
|
||||
IdentitySource: $request.header.Authorization
|
||||
JwtConfiguration:
|
||||
issuer: https://auth.example.com
|
||||
audience: [api.example.com]
|
||||
DefaultAuthorizer: JwtAuth
|
||||
RouteSettings:
|
||||
"POST /orders":
|
||||
ThrottlingBurstLimit: 100
|
||||
ThrottlingRateLimit: 50
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### LLM gateway (Portkey-style fallback)
|
||||
```python
|
||||
from portkey_ai import Portkey
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
client = Portkey(
|
||||
api_key="...",
|
||||
config={
|
||||
"strategy": {"mode": "fallback"},
|
||||
"targets": [
|
||||
{"provider": "anthropic", "override_params": {"model": "claude-opus-4-7"}},
|
||||
{"provider": "openai", "override_params": {"model": "gpt-5"}},
|
||||
],
|
||||
"cache": {"mode": "semantic", "max_age": 3600},
|
||||
},
|
||||
)
|
||||
resp = client.chat.completions.create(messages=[{"role":"user","content":"hi"}])
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### Rate limit (token bucket, Redis)
|
||||
```lua
|
||||
-- Kong-style Redis Lua
|
||||
local key = "rl:" .. consumer_id
|
||||
local tokens = tonumber(redis.call("GET", key) or "100")
|
||||
if tokens <= 0 then return 429 end
|
||||
redis.call("DECR", key)
|
||||
redis.call("EXPIRE", key, 60)
|
||||
return 200
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### Header-based canary
|
||||
```yaml
|
||||
routes:
|
||||
- match:
|
||||
prefix: "/v1/checkout"
|
||||
headers: [{name: "x-canary", exact_match: "true"}]
|
||||
route: { cluster: checkout_v2 }
|
||||
- match: { prefix: "/v1/checkout" }
|
||||
route: { cluster: checkout_v1 }
|
||||
```
|
||||
|
||||
### gRPC-Web transcoding
|
||||
```yaml
|
||||
http_filters:
|
||||
- name: envoy.filters.http.grpc_web
|
||||
- name: envoy.filters.http.grpc_json_transcoder
|
||||
typed_config:
|
||||
proto_descriptor: /etc/proto/api.pb
|
||||
services: ["api.OrderService"]
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| Public SaaS API, multi-tenant | Kong / AWS API Gateway |
|
||||
| Service mesh edge ingress | Envoy + Istio Gateway |
|
||||
| Single-team internal API | Skip gateway → direct service + library SDK |
|
||||
| Multi-LLM provider | Portkey / LiteLLM gateway |
|
||||
| Heterogeneous protocols (REST+gRPC+WS) | Envoy with transcoding filters |
|
||||
|
||||
**기본값**: 매 Envoy-based (Istio Gateway / Contour) 의 in-cluster, AWS API Gateway 의 fully managed edge.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Microservices]] · [[Edge Computing]]
|
||||
- 변형: [[Backend for Frontend (BFF)]] · [[Service Mesh]] · [[Reverse Proxy]]
|
||||
- 응용: [[Rate Limiting]] · [[OAuth2]] · [[mTLS]]
|
||||
- Adjacent: [[Load Balancer]] · [[CDN]] · [[Ingress Controller]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 multi-service public API, 매 cross-cutting concerns (auth/rate-limit/observability) 의 centralization, 매 multi-provider LLM routing.
|
||||
**언제 X**: 매 single monolith, 매 internal service-to-service only (use mesh sidecar), 매 hot path 의 < 100us latency 요구.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Smart gateway**: 매 business logic 의 gateway 에 stuff — 매 deployment coupling 의 발생.
|
||||
- **Single gateway for all clients**: 매 mobile/web/partner 매 BFF 의 분리 안 함 → over-fetching.
|
||||
- **No timeout/retry budget**: 매 cascading failure 의 발생.
|
||||
- **Auth-only gateway, no rate limit**: 매 abuse vector.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Kong docs, Envoy docs, AWS API Gateway docs, Microsoft Azure Architecture Center "Gateway Aggregation" pattern).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — full content (Kong/Envoy/AWS/LLM gateway patterns) |
|
||||
|
||||
Reference in New Issue
Block a user