How to generate an OpenAPI/Swagger spec with gRPC Gateway

You may want to provide a RESTful API in addition to your gRPC service without the need to duplicate your code.

gRPC Gateway (opens in a new tab) is a popular tool for generating RESTful APIs from gRPC service definitions.

In this tutorial, we’ll take a detailed look at how to use gRPC Gateway to generate an OpenAPI schema based on a Protocol Buffers (protobuf) gRPC service definition. Afterward, we can use Speakeasy to read our generated OpenAPI schema and create a production-ready SDK.

TIP

If you want to follow along, you can use the gRPC Speakeasy Bar example repository (opens in a new tab).

An Overview of gRPC Gateway

gRPC Gateway (opens in a new tab) is a protoc (opens in a new tab) plugin that reads gRPC service definitions and generates a reverse proxy server that translates a RESTful JSON API into gRPC.

This way, you can expose an HTTP endpoint that can be called by clients that don’t support gRPC. The generated server code will forward incoming JSON requests to your gRPC server and translate the responses to JSON.

gRPC Gateway also generates an OpenAPI schema that describes your API. You can use this schema to create SDKs for your API.

OpenAPI Versions

gRPC Gateway outputs OpenAPI 2.0, and Speakeasy supports OpenAPI 3.0 and 3.1. To generate an OpenAPI 3.0 or 3.1 schema, you’ll need to convert the OpenAPI 2.0 schema to at least OpenAPI 3.0.

The Protobuf to REST SDK Pipeline

To generate a REST API with a developer-friendly SDK, we’ll follow these three core steps:

1. gRPC to OpenAPI: First, we will use gRPC Gateway to produce an OpenAPI schema based on our protobuf service definition. This generated schema is in OpenAPI 2.0 format.

2. OpenAPI 2.0 to OpenAPI 3.x: Next, as gRPC Gateway’s output schema is in OpenAPI 2.0 and we need at least OpenAPI 3.0 for our SDK, we will convert the generated schema from OpenAPI 2.0 to OpenAPI 3.0.

3. OpenAPI 3.x to SDK: Finally, once we have the OpenAPI 3.0 schema, we will leverage Speakeasy to create our SDK based on the OpenAPI 3.0 schema derived from the previous steps.

By following these steps, we can ensure we have a robust, production-ready SDK that adheres to our API’s specifications.

Step-by-Step Tutorial: From Protobuf to OpenAPI to an SDK

Now let’s walk through generating an OpenAPI schema and SDK for our Speakeasy Bar gRPC service.

Check Out the Example Repository

If you would like to follow along, start by cloning the example repository:

git clone git@github.com:speakeasy-api/speakeasy-grpc-gateway-example.git
cd speakeasy-grpc-gateway-example

Install Go

To generate an OpenAPI schema from a protobuf file, we’ll need to install Go and protoc.

This tutorial was written using Go 1.21.4.

On macOS, install Go by running:

brew install go

Alternatively, follow the Go installation instructions (opens in a new tab) for your platform.

Install Buf

We’ll use the Buf CLI (opens in a new tab) as an alternative to protoc so that we can save our generation configuration as YAML. Buf is compatible with protoc plugins.

On macOS, install Buf by running:

brew install bufbuild/buf/buf

Alternatively, follow the Buf CLI installation instructions (opens in a new tab) for your platform.

Install Buf Modules

We’ll use Buf modules to manage our dependencies.

cd proto
buf mod update
cd ..

Install protoc-gen-go

Buf requires the protoc-gen-go plugin to generate Go code from protobuf files.

Install protoc-gen-go by running:

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

Make sure that the protoc-gen-go binary is in your $PATH. On macOS, you can achieve that by running the following command if the go/bin directory is not already in your path.

export PATH=${PATH}:`go env GOPATH`/bin

Install Go Requirements

go mod tidy
go install \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
    google.golang.org/protobuf/cmd/protoc-gen-go \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc

Generate the Go Code

We’ll use Buf to generate the Go code from the protobuf file.

Run the following in the terminal:

buf generate

Buf reads the configuration in buf.gen.yaml, then generates the Go code in the proto directory.

This will generate the proto/speakeasy/v1/speakeasy.pb.go, proto/speakeasy/v1/speakeasy_grpc.pb.go, and proto/speakeasy/v1/speakeasy.pb.gw.go files.

Generate the OpenAPI Schema

Because we have the openapiv2 protoc plugin configured in our buf.gen.yaml file, Buf will generate an OpenAPI schema and save it as openapi/speakeasy/v1/speakeasy.swagger.json.

This is the OpenAPI 2.0 schema that gRPC Gateway generates by default.

Convert the OpenAPI Schema to OpenAPI 3.0

We’ll use the excellent kin-openapi (opens in a new tab) Go library to convert the OpenAPI 2.0 schema to OpenAPI 3.0.

In convert/convert.go, we use kin-openapi to unmarshal openapi/speakeasy/v1/speakeasy.swagger.json, then convert it to OpenAPI 3.0, then marshal it back to JSON, and finally write it to openapi/speakeasy/v1/speakeasy.openapi.json.

To do the conversion, run the following in the terminal:

go run convert/convert.go

How To Customize the API Schema

By modifying the protobuf service definition, we can customize the generated OpenAPI schema.

We’ll start with a basic example and add options to enhance the schema.

syntax = "proto3";

package speakeasy;

import "google/protobuf/empty.proto";
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";

message Drink {

  string name = 1 [
    (google.api.field_behavior) = REQUIRED
  ];

  enum DrinkType {
    DRINK_TYPE_UNSPECIFIED = 0;
    DRINK_TYPE_WINE = 1;
    DRINK_TYPE_COCKTAIL = 2;
    DRINK_TYPE_MOCKTAIL = 3;
    DRINK_TYPE_SOFT = 4;
    DRINK_TYPE_SPIRIT = 5;
    DRINK_TYPE_OTHER = 6;
    DRINK_TYPE_BEER = 7;
  };
  DrinkType type = 2 [
    (google.api.field_behavior) = REQUIRED
  ];

  double price = 3;
  int32 stock = 4;
  string productCode = 5;
};

message ListDrinksResponse { repeated Drink drinks = 1; }

message ListDrinksRequest { google.protobuf.Empty empty = 1; }

message GetDrinkResponse { Drink drink = 1; }

message GetDrinkRequest { string product_code = 1; }

service SpeakeasyService {

  // List all drinks
  rpc ListDrinks(ListDrinksRequest) returns (ListDrinksResponse) {
    option (google.api.http) = {
      get: "/v1/drinks"
      response_body: "drinks"
    };
  };

  // Get a drink by product code
  rpc GetDrink(GetDrinkRequest) returns (GetDrinkResponse) {
    option (google.api.http) = {
      get: "/v1/drinks/{product_code}"
      response_body: "drink"
    };
  };
};

Create an SDK With Speakeasy

Now that we have an OpenAPI 3.0 schema, we can create an SDK with Speakeasy. Speakeasy will create documentation and usage examples based on the descriptions and examples we added.

We’ll use the speakeasy quickstart command to create an SDK for the Speakeasy Bar gRPC service.

Run the following in the terminal:

speakeasy quickstart

Follow the onscreen prompts to provide the necessary configuration details for your new SDK such as the name, schema location and output path. Enter openapi/speakeasy/v1/speakeasy.openapi.json when prompted for the OpenAPI document location and select TypeScript when prompted for which language you would like to generate.

Example Protobuf Definition and SDK Generator

The source code for our complete example is available in the gRPC Speakeasy Bar example repository (opens in a new tab).

The repository contains a TypeScript SDK and instructions on how to create more SDKs.

You can clone this repository to test how changes to the protobuf definition result in changes to the SDK.

After modifying your protobuf definition, you can run the following in the terminal to create a new SDK:

buf generate && go run convert/convert.go && speakeasy quickstart

Happy generating!