grpc_graphql_gateway 1.2.4

A Rust implementation of gRPC-GraphQL gateway - generates GraphQL execution code from gRPC services
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

# Configuration Reference

Complete reference for all gateway configuration options.

## GatewayBuilder Methods

### Core Configuration

| Method | Description |
|--------|-------------|
| `.with_descriptor_set_bytes(bytes)` | Set primary proto descriptor |
| `.add_descriptor_set_bytes(bytes)` | Add additional proto descriptor |
| `.with_descriptor_set_file(path)` | Load primary descriptor from file |
| `.add_descriptor_set_file(path)` | Load additional descriptor from file |
| `.add_grpc_client(name, client)` | Register a gRPC backend client |
| `.with_services(services)` | Restrict to specific services |

### Federation

| Method | Description |
|--------|-------------|
| `.enable_federation()` | Enable Apollo Federation v2 |
| `.with_entity_resolver(resolver)` | Custom entity resolver |

### Security

| Method | Description |
|--------|-------------|
| `.with_query_depth_limit(n)` | Max query nesting depth |
| `.with_query_complexity_limit(n)` | Max query complexity |
| `.disable_introspection()` | Block `__schema` queries |

### Middleware

| Method | Description |
|--------|-------------|
| `.add_middleware(middleware)` | Add custom middleware |
| `.with_error_handler(handler)` | Custom error handler |

### Performance

| Method | Description |
|--------|-------------|
| `.with_response_cache(config)` | Enable response caching |
| `.with_compression(config)` | Enable response compression |
| `.with_persisted_queries(config)` | Enable APQ |
| `.with_circuit_breaker(config)` | Enable circuit breaker |

### Production

| Method | Description |
|--------|-------------|
| `.enable_health_checks()` | Add `/health` and `/ready` endpoints |
| `.enable_metrics()` | Add `/metrics` Prometheus endpoint |
| `.enable_tracing()` | Enable OpenTelemetry tracing |
| `.with_graceful_shutdown(config)` | Enable graceful shutdown |
| `.with_header_propagation(config)` | Forward headers to gRPC |

## Environment Variables

Configure via environment variables:

```bash
# Query limits
QUERY_DEPTH_LIMIT=10
QUERY_COMPLEXITY_LIMIT=100

# Environment
ENV=production  # Affects introspection default

# Tracing
OTEL_EXPORTER_OTLP_ENDPOINT=http://jaeger:4317
OTEL_SERVICE_NAME=graphql-gateway
```

## Configuration Structs

### CacheConfig

```rust
CacheConfig {
    max_size: 10_000,
    default_ttl: Duration::from_secs(60),
    stale_while_revalidate: Some(Duration::from_secs(30)),
    invalidate_on_mutation: true,
    redis_url: Some("redis://127.0.0.1:6379".to_string()),
}
```

### CompressionConfig

```rust
CompressionConfig {
    enabled: true,
    level: CompressionLevel::Default,
    min_size_bytes: 1024,
    algorithms: vec!["br".into(), "gzip".into()],
}

// Presets
CompressionConfig::fast()
CompressionConfig::best()
CompressionConfig::default()
CompressionConfig::disabled()
```

### CircuitBreakerConfig

```rust
CircuitBreakerConfig {
    failure_threshold: 5,
    recovery_timeout: Duration::from_secs(30),
    half_open_max_requests: 3,
}
```

### PersistedQueryConfig

```rust
PersistedQueryConfig {
    cache_size: 1000,
    ttl: Some(Duration::from_secs(3600)),
}
```

### ShutdownConfig

```rust
ShutdownConfig {
    timeout: Duration::from_secs(30),
    handle_signals: true,
    force_shutdown_delay: Duration::from_secs(5),
}
```

### HeaderPropagationConfig

```rust
HeaderPropagationConfig::new()
    .propagate("authorization")
    .propagate_with_prefix("x-custom-")
    .exclude("cookie")

// Preset
HeaderPropagationConfig::common()
```

### TracingConfig

```rust
TracingConfig::new()
    .with_service_name("my-gateway")
    .with_sample_ratio(0.1)
    .with_otlp_endpoint("http://jaeger:4317")
```