ginrpc

ginrpc

An RPC-style web framework based on GIN. You can not only have an RPC-style coding experience, but also enjoy the benefits of gin's complete ecology and REST-style flexibility

Use slog, which will soon be added to the standard library, as the framework's preferred logging component

• go1.19+ golang.org/x/exp/slog
• go1.21+ log/slog

Quick Start

Define input and output parameters

type InRequest struct{
    Name string     `uri:"name" binding:"required"`
}

type OutResponse struct{
    Data string     `json:"data"`
}

Edit handler

func Hello(ctx context.Context, in *InRequest) (*OutRequest, error){
    slog.InfoCtx(ctx, "revice", slog.String("name",in.Name))
    return &OutResponse{
        Data: "hello " + in.Name
    }, nil
}

Register route

srv := ginrpc.New(
    ginrpc.WithAddr(":8082"),
)
srv.Get("/hello/:name", Hello)
srv.Start()

// request http://localhost:8082/hello/afocus
// response {"data":"hello afocus"}

full examples can be checked out from below

Old project transformation 已有项目改造

e:=gin.New()

e.Use(...)

+ srv:=ginrpc.New(
+     ginrpc.WithAddr(":8082"),
+     ginrpc.WithGinEngine(e),
+ )

e.GET("/", func(*gin.Context){})
- e.GET("/userpc", func(*gin.Context){})
+ srv.Get("/userpc", useRpcHandler) // gin style -> rpc style
+ e.GET("/userpc2", srv.HandleFunc(useRpcHandler)) // rpc style -> gin style

- e.Run(":8082")
+ srv.Start()

Incompatible

bind query

gin uses the structure tag:form to support query and only supports GET request

type QueryReq struct{
    // gin
    // Keyword string `form:"q"`
    // ginrpc
    Keyword string `query:"q"`
}

Road map

• support otel tracing
• automatically generate openapi documentation