This directory contains API definitions written in Protocol Buffers. These definitions will be used for building services.

To successfully run the generation commands, ensure the following tools are installed in your environment:

• Make
• Docker

Run the following command to build the proto-generator image. This image will be used for generating APIs:

Note: You can actually skip this step, and a prebuilt image will be downloaded instead.

make build-image

make generate

We postpone the client generation until there is a need for external service communication.

Use the tools bootprint-openapi and html-inline to generate API reference documentation from the Swagger files. For more information on the API and architecture, refer to the design document.

Third-party proto dependencies are synchronized back to proto/third_party for easier development (IDE friendly). Ideally, the directory for searching imports should be specified instead.

protoc -I.
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/ \
    -I/go/src/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/options/ \

Sources:

• googleapis
• protoc-gen-openapiv2