README
¶
rpc
RPC is a small remote procedure call library with a focus on building REST-ish APIs that can be natively called from the browser.
Why build yet another RPC library?
-
GRPC support for the web browser is dismal
-
GRPC tooling is not fun and not fast
-
GRPC can't run natively in a servless context
-
The Go RPC library focuses on Go to Go services
What is this library trying to do?
-
Be grok-able
-
Be orthogonal
-
Get out of its own way
-
Runnable in a servless context
Non-goals
- Be a cross language, general purpose RPC framework.
Documentation
¶
Index ¶
- Variables
- func GetHandlerNameFromContext(ctx context.Context) string
- func HandleError(w http.ResponseWriter, err error)
- func Register[Input any, Output any](mux *http.ServeMux, httpMethod HTTPMethod, path string, ...)
- func RegisterDocsEndpoint(mux *http.ServeMux)
- func RegisterMiddleware(middlewware ...Middleware)
- func SetHandlerNameInContext(ctx context.Context, handlerName string) context.Context
- type HTTPMethod
- type Middleware
- type RpcEndpoint
- type RpcError
- type RpcHandler
Constants ¶
This section is empty.
Variables ¶
var InternalServerError = RpcError{HTTPCode: 500, Message: "Internal Server Error"}
Functions ¶
func HandleError ¶
func HandleError(w http.ResponseWriter, err error)
func Register ¶
func Register[Input any, Output any](mux *http.ServeMux, httpMethod HTTPMethod, path string, h RpcHandler[Input, Output], rpcMiddleware ...Middleware)
Register registers a new RPC handler to the given mux. handlers are applied in the order they are registered. Handlers regiestered with RegisterMiddleware are applied first.
func RegisterDocsEndpoint ¶
func RegisterMiddleware ¶
func RegisterMiddleware(middlewware ...Middleware)
RegisterMiddleware registers a middleware that is used for all RPCs that are registed. Use the handlers argument in Register to apply RPC specific middleware in addition to the default middleware.
Handlers are applied in the order they are registered.
Types ¶
type HTTPMethod ¶
type HTTPMethod string
const ( GET HTTPMethod = http.MethodGet POST HTTPMethod = http.MethodPost )
type RpcEndpoint ¶
type RpcEndpoint struct {
Path string `json:"path"`
HTTPMethod HTTPMethod `json:"httpMethod"`
InputType string `json:"inputType"`
Input interface{} `json:"input"`
OutputType string `json:"outputType"`
Output interface{} `json:"output"`
}
Docs
Source Files