HttpBody Messages

The HTTPBody messages allow a response message to be specified with custom data content and a custom content-type header. The values included in the HTTPBody response will be used verbatim in the returned message from the gateway. Make sure you format your response carefully!

Example Usage

  1. Define your service in gRPC with an httpbody response message
  1. import "google/api/httpbody.proto";
  2. import "google/api/annotations.proto";
  3. import "google/protobuf/empty.proto";
  5. service HttpBodyExampleService {
  6.     rpc HelloWorld(google.protobuf.Empty) returns (google.api.HttpBody) {
  7.         option (google.api.http) = {
  8.             get: "/helloworld"
  9.         };
  10.     }
  11.     rpc Download(google.protobuf.Empty) returns (stream google.api.HttpBody) {
  12.         option (google.api.http) = {
  13.             get: "/download"
  14.         };
  15.     }
  16. }
  1. Generate gRPC and reverse-proxy stubs and implement your service.

Example service implementation

  1. func (*HttpBodyExampleService) Helloworld(ctx context.Context, in *empty.Empty) (*httpbody.HttpBody, error) {
  2.     return &httpbody.HttpBody{
  3.         ContentType: "text/html",
  4.         Data:        []byte("Hello World"),
  5.     }, nil
  6. }
  8. func (HttpBodyExampleService) Download(_ *empty.Empty, stream HttpBodyExampleService_DownloadServer) error {
  9.     msgs := []*httpbody.HttpBody{
  10.         {
  11.             ContentType: "text/html",
  12.             Data:        []byte("Hello 1"),
  13.         },
  14.         {
  15.             ContentType: "text/html",
  16.             Data:        []byte("Hello 2"),
  17.         },
  18.     }
  20.     for _, msg := range msgs {
  21.         if err := stream.Send(msg); err != nil {
  22.             return err
  23.         }
  24.     }
  26.     return nil
  27. }