Adding custom routes to the mux

The gRPC-Gateway allows you to add custom routes to the serve mux, for example, if you want to support a use case that isn’t supported by the gRPC-Gateway, like file uploads.

Example

package main
import (
    "context"
    "net/http"
    pb "github.com/grpc-ecosystem/grpc-gateway/v2/examples/internal/helloworld"
    "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
)
func main() {
    ctx := context.TODO()
    mux := runtime.NewServeMux()
    // Register generated routes to mux
    err := pb.RegisterGreeterHandlerServer(ctx, mux, &GreeterServer{})
    if err != nil {
        panic(err)
    }
    // Register custom route for  GET /hello/{name}
    err = mux.HandlePath("GET", "/hello/{name}", func(w http.ResponseWriter, r *http.Request, pathParams map[string]string) {
        w.Write([]byte("hello " + pathParams["name"]))
    })
    if err != nil {
        panic(err)
    }
    http.ListenAndServe(":8080", mux)
}
// GreeterServer is the server API for Greeter service.
type GreeterServer struct {
}
// SayHello implement to say hello
func (h *GreeterServer) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloReply, error) {
    return &pb.HelloReply{
        Message: "hello " + req.Name,
    }, nil
}