grpc-ecosystem/grpc-gateway
Grpc Gateway
This project is a REST-to-gRPC API gateway and JSON reverse proxy that translates RESTful HTTP requests into gRPC service calls. It functions as a protocol buffer proxy generator, providing the tools necessary to bridge JSON-based HTTP traffic with backend gRPC servers.
The system distinguishes itself by automating the creation of reverse-proxy servers and stubs through protobuf-driven code generation. It also includes a dedicated OpenAPI specification generator that produces OpenAPI v2 and v3 documents from gRPC service definitions and annotations.
The project covers a broad range of integration capabilities, including JSON-to-gRPC transcoding, request and response handling, and binary body processing. It supports advanced routing via annotation-based mapping, field-mask-based partial updates, and newline-delimited stream serialization for HTTP delivery.
Additional utility areas include observability through distributed trace propagation and health check endpoints, security controls to disable HTTP method overrides, and the ability to multiplex HTTP and gRPC traffic on a shared network port.
Features
- gRPC API Gateways - Provides a single entry point that translates external HTTP JSON traffic into internal gRPC service communication.
- JSON Transcoding - Translates RESTful HTTP requests into gRPC calls by mapping URL parameters and JSON bodies to protobuf messages.
- HTTP-to-gRPC Transcoding - Converts RESTful HTTP requests into gRPC service calls using a generated reverse-proxy server.
- Protobuf-Based Proxy Generation - Translates RESTful HTTP requests into gRPC calls by generating a proxy server from protocol buffer definitions.
- REST to gRPC Mapping - Translates HTTP requests into gRPC service calls using protocol buffer annotations or external configs.
- REST-to-gRPC Translation - Converts RESTful HTTP requests into gRPC service calls using a reverse-proxy server generated from protocol definitions.
- OpenAPI Specification Generators - A tool that produces OpenAPI v2 and v3 JSON documents from gRPC service definitions and annotations.
- Protobuf-to-Go Generators - Generates a reverse-proxy server in Go by analyzing protocol buffer files.
- Service Stub Generators - Automatically generates the boilerplate code and service stubs required to bridge HTTP traffic to gRPC servers.
- Proxy Stubs - Produces source code stubs that bridge HTTP and gRPC based on protocol buffer annotations.
- Proxy Boilerplate Generators - Creates the boilerplate and stubs needed to bridge JSON-based HTTP traffic with gRPC servers.
- gRPC JSON Reverse Proxies - Translates RESTful HTTP requests into gRPC service calls based on protocol buffer definitions.
- JSON API Proxies - Routes HTTP requests to backend services while managing the serialization and deserialization of JSON payloads.
- REST-to-gRPC Gateways - Maps HTTP paths and query parameters to gRPC messages for exposing backend services as REST APIs.
- Annotation-Based Route Mapping - Maps HTTP paths and methods to gRPC services using custom options embedded in protocol buffer definitions.
- REST to gRPC Translation - Converts incoming HTTP API calls into gRPC service requests by mapping URL paths and query parameters.
- gRPC Service Mapping - Provides the mapping logic that links RESTful endpoints to their corresponding gRPC service implementations.
- Header-to-Metadata Mapping - Translates incoming HTTP request headers into gRPC client metadata and converts server metadata back into response headers.
- OpenAPI Specification Generators - Automatically derives OpenAPI specifications from gRPC service definitions and protobuf message types.
- Field Masks - Uses field masks to specify exactly which fields to update in a resource during HTTP PATCH operations.
- Newline-Delimited JSON Streams - Maps gRPC server streams to newline-delimited JSON streams for compatible HTTP delivery.
- API Error Handling - Allows overriding default error responses to transform payloads and strip sensitive data from routing failures.
- Distributed Trace Propagation - Passes tracing spans from incoming HTTP requests through to backend services using standard headers.
- Multi-Protocol Port Multiplexing - Shares a single network port between a server, a reverse proxy, and custom handlers.
- Partial Update Strategies - Implements partial update strategies using field masks during HTTP PATCH operations.
- gRPC Metadata Transformation - Intercepts HTTP requests and responses to translate headers into gRPC metadata and vice versa.
- Binary Body Processing - Processes raw request and response bodies using binary message types to bypass standard JSON serialization.
- Dynamic Response Statuses - Controls the HTTP status code returned to the client by intercepting gRPC metadata.
- Query Parameter Parsers - Translates complex or nested HTTP query parameters into specific gRPC request message fields using custom parsing.
- Protobuf-to-OpenAPI Mappers - Translates protocol buffer messages and enums into OpenAPI component schemas, including support for 64-bit integers.
- RPC Frameworks - Reverse proxy to expose gRPC as RESTful APIs.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
