自定义路径

如何在 grpc-gateway 中添加自定义访问路径？

概述

默认情况下，grpc-gateway 会在 GRPC 函数上面创建 Restful API。但是在某些情况下，我们希望 grpc-gateway 同时提供自定义的 Restful API，而非 GRPC 方法。

grpc-gateway 已经支持了此功能。

快速开始

• 安装

$ go get github.com/rookie-ninja/rk-boot/v2
$ go get github.com/rookie-ninja/rk-grpc/v2

1.创建 boot.yaml

---
grpc:
  - name: greeter                   # Name of grpc entry
    port: 8080                      # Port of grpc entry
#   gwPort: 8081                    # Optional, default: gateway port will be the same as grpc port if not provided
    enabled: true                   # Enable grpc entry

2.创建 main.go

package main

import (
  "context"
  "github.com/rookie-ninja/rk-boot/v2"
  "github.com/rookie-ninja/rk-grpc/v2/boot"
  "net/http"
)

func main() {
  boot := rkboot.NewBoot()

  // Bootstrap
  boot.Bootstrap(context.TODO())

  // register grpc
  entry := rkgrpc.GetGrpcEntry("greeter")

  // !!!!!!
  // This codes should be located after Bootstrap()
  entry.GwMux.HandlePath("GET", "/custom", func(w http.ResponseWriter, r *http.Request, pathParams map[string]string) {
    w.Write([]byte("Custom routes!"))
  })

  // Wait for shutdown sig
  boot.WaitForShutdownSig(context.TODO())
}

3.验证

$ curl "localhost:8080/custom"
Custom routes!

Cheers