This repository contains a gRPC Swift API and code generator.
It is intended for use with Apple's SwiftProtobuf support for
Protocol Buffers. Both projects contain code generation plugins for
Google's Protocol Buffer compiler, and both contain libraries of supporting code
that is needed to build and run the generated code.
APIs and generated code is provided for both gRPC clients and servers, and can be built either with Xcode or the Swift Package Manager. Support is provided for all four gRPC API styles (Unary, Server Streaming, Client Streaming, and Bidirectional Streaming) and connections can be made either over secure (TLS) or insecure channels.
||gRPC-Swift||Actively developed and supported|
|0.x||gRPC C library||
||SwiftGRPC||No longer developed; security fixes only|
The remainder of this README refers to the 1.x version of gRPC Swift.
Swift 5.5 introduces new language features for concurrency. One such feature is
gRPC Swift includes experimental support for async/await. While support is experimental, async/await releases of gRPC Swift do not guarantees a stable API. Features and APIs may change between async/await releases.
To ensure the 1.x release series does maintain a stable API, async/await releases
will be branched from stable releases and tagged in the following format:
X.Y.Z indicates the tag of the stable release
from which the branch was created and
N indicates a release number on that
protoc-gen-grpc-swift options for generating async/await style clients and
servers are described in
gRPC Swift's platform support is identical to the platform support of Swift NIO.
Note that gRPC Swift uses NIO 2 and requires Swift to be version 5.2 or higher.
Getting gRPC Swift
There are two parts to gRPC Swift: the gRPC library and an API code generator.
Getting the gRPC library
Swift Package Manager
The Swift Package Manager is the preferred way to get gRPC Swift. Simply add the
package dependency to your
dependencies: [ .package(url: "https://github.com/grpc/grpc-swift.git", from: "1.0.0") ]
...and depend on
"GRPC" in the necessary targets:
.target( name: ..., dependencies: [.product(name: "GRPC", package: "grpc-swift")] ]
From Xcode 11 it is possible to add Swift Package dependencies to Xcode
projects and link targets to products of those packages; this is the
easiest way to integrate gRPC Swift with an existing
Alternatively, gRPC Swift can be manually integrated into a project:
- Build an Xcode project:
swift package generate-xcodeproj,
- Add the generated project to your own project, and
- Add a build dependency on
gRPC Swift is currently available from CocoaPods. To integrate, add
the following line to your
pod 'gRPC-Swift', '~> 1.0.0'
pod install from command line and use your project's generated
.xcworkspace file. You might also need to add
use_frameworks! to your
Binary releases of
protoc, the Protocol Buffer Compiler, are available on
To build the plugins, run
make plugins in the main directory. This uses the
Swift Package Manager to build both of the necessary plugins:
protoc-gen-swift, which generates Protocol Buffer support code and
protoc-gen-grpc-swift, which generates gRPC interface code.
To install these plugins, just copy the two executables (
protoc-gen-grpc-swift) that show up in the main directory into a directory
that is part of your
PATH environment variable. Alternatively the full path to
the plugins can be specified when using
Alternatively, you can get the latest precompiled version of the plugins by adding
the following line to your
The plugins are available in the
Pods/gRPC-Swift-Plugins/ folder afterwards.
gRPC Swift has a number of tutorials and examples available. They are split across two directories:
/Sources/Examplescontains examples which do not require additional dependencies and may be built using the Swift Package Manager.
/Examplescontains examples which rely on external dependencies or may not be built by the Swift Package Manager (such as an iOS app).
Some of the examples are accompanied by tutorials, including:
- A quick start guide for creating and running your first gRPC service.
- A basic tutorial covering the creation and implementation of a gRPC service using all four call types as well as the code required to setup and run a server and make calls to it using a generated client.
- An interceptors tutorial covering how to create and use interceptors with gRPC Swift.
docs directory contains documentation, including:
- Options for the
- How to configure TLS in
- How to configure keepalive in
- Support for Apple Platforms and NIO Transport Services in
Please see SECURITY.md.
Please get involved! See our guidelines for contributing.