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

# Installation

## Add to Cargo.toml

```toml
[dependencies]
grpc_graphql_gateway = "0.2"
tokio = { version = "1", features = ["full"] }
tonic = "0.12"
```

## Optional Features

The gateway supports optional features that can be enabled in `Cargo.toml`:

```toml
[dependencies]
grpc_graphql_gateway = { version = "0.2", features = ["otlp"] }
```

| Feature | Description |
|---------|-------------|
| `otlp` | Enable OpenTelemetry Protocol export for distributed tracing |

## Prerequisites

Before using the gateway, ensure you have:

1. **Rust 1.70+** - The gateway uses modern Rust features
2. **Protobuf Compiler** - `protoc` for generating descriptor files
3. **gRPC Services** - Backend services to proxy requests to

## Installing protoc

### macOS
```bash
brew install protobuf
```

### Ubuntu/Debian
```bash
sudo apt-get install protobuf-compiler
```

### Windows
Download from the [protobuf releases page](https://github.com/protocolbuffers/protobuf/releases).

## Proto Annotations

To use the gateway, your `.proto` files need GraphQL annotations. Copy the `graphql.proto` file from the repository:

```bash
curl -o proto/graphql.proto https://raw.githubusercontent.com/Protocol-Lattice/grpc_graphql_gateway/main/proto/graphql.proto
```

This file defines the custom options like `graphql.schema`, `graphql.field`, and `graphql.entity` that the gateway uses to generate the GraphQL schema.

## Next Steps

Once installed, proceed to the [Quick Start](./quick-start.md) guide to create your first gateway.