API Design

When designing a gRPC API, you could take into consideration some of the Google Cloud API Design Patterns.

Methods without request or response

If you want to create an endpoint that takes no parameters or produces no response, it might be tempting to use the Empty type as defined by Google in their empty.proto.

It is recommended to introduce your own (empty) message types, however, as functionality may grow and this prepares you for adding additional (optional) fields over time.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.