grpc-ecosystem/grpc-gateway

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