go_grpc_protovalidate

README

go-grpc-protovalidate

[!CAUTION] WORK IN PROGRESS

A gRPC Go middleware for validating messages via bufbuild/protovalidate following Google's API Improvement Proposals AIP-193.

Installation

go get github.com/rudeigerc/go-grpc-protovalidate

Usage

package main

import (
	"log"

	"github.com/bufbuild/protovalidate-go"
	go_grpc_protovalidate "github.com/rudeigerc/go-grpc-protovalidate"
	"google.golang.org/grpc"
)

func main() {
	validator, err := protovalidate.New()
	if err != nil {
		log.Fatalf("failed to create validator: %v", err)
	}

	s := grpc.NewServer(
		grpc.ChainUnaryInterceptor(
			go_grpc_protovalidate.UnaryServerInterceptor(go_grpc_protovalidate.WithValidator(validator)),
		),
		grpc.ChainStreamInterceptor(
			go_grpc_protovalidate.StreamServerInterceptor(go_grpc_protovalidate.WithValidator(validator)),
		),
	)
}

References

• bufbuild/protovalidate
• grpc-ecosystem/go-grpc-middleware/interceptors/protovalidate
• Errors  |  Cloud API Design Guide  |  Google Cloud
• AIP-193: Errors

License

Apache 2.0

Documentation

Index

• func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
• func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
• type Option
  • func WithValidator(validator *protovalidate.Validator) Option

Functions

func StreamServerInterceptor

func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor

func UnaryServerInterceptor

func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor

Types

type Option

type Option func(*options)

func WithValidator

func WithValidator(validator *protovalidate.Validator) Option