handler

Documentation

Index

• func Add[I, O any](srv *server.Server, method string, path string, ...)
• func AddHealthCheck(srv *server.Server)
• type Config
• type Endpoint
• type Health
  • func HealthCheck(ctx context.Context, req *model.Empty) (*Health, error)

Functions

func Add

func Add[I, O any](srv *server.Server, method string, path string, f func(context.Context, *I) (*O, error), configs ...Config)

func AddHealthCheck

func AddHealthCheck(srv *server.Server)

Types

type Config

type Config struct {
	Summary      string
	Description  string
	Tags         []string
	Authenticate bool
	SuperAdmin   bool
	Permission   string
}

type Endpoint

type Endpoint[I, O any] struct {
	Server      *server.Server
	Method      string
	Path        string
	Func        func(context.Context, *I) (*O, error)
	Summary     string
	Description string
	Tags        []string
}

type Health

type Health struct {
	Status string `json:"status" example:"ok"`
}

func HealthCheck

func HealthCheck(ctx context.Context, req *model.Empty) (*Health, error)