bifrost

README

Bifröst

Description Project

Prerequisites

• Go 1.16+

Documentation

Index

• Constants
• Variables
• func Base64ToImg(w io.Writer, base string) (string, error)
• func BindBody(r *http.Request, i interface{}) error
• func ErrBadGateway(w http.ResponseWriter, r *http.Request, err error) error
• func ErrBadRequest(w http.ResponseWriter, r *http.Request, err error) error
• func ErrForbidden(w http.ResponseWriter, r *http.Request, err error) error
• func ErrGatewayTimeout(w http.ResponseWriter, r *http.Request, err error) error
• func ErrInternalServerError(w http.ResponseWriter, r *http.Request, err error) error
• func ErrMethodNotAllowed(w http.ResponseWriter, r *http.Request, err error) error
• func ErrNotAcceptable(w http.ResponseWriter, r *http.Request, err error) error
• func ErrPaymentRequired(w http.ResponseWriter, r *http.Request, err error) error
• func ErrProxyAuthRequired(w http.ResponseWriter, r *http.Request, err error) error
• func ErrRequestTimeout(w http.ResponseWriter, r *http.Request, err error) error
• func ErrServiceUnavailable(w http.ResponseWriter, r *http.Request, err error) error
• func ErrUnauthorized(w http.ResponseWriter, r *http.Request, err error) error
• func ErrUnprocessableEntity(w http.ResponseWriter, r *http.Request, err error) error
• func ErrUnsupportedMediaType(w http.ResponseWriter, r *http.Request, err error) error
• func GetIdxContentType(s ContentType) string
• func GetRootSchema(graphql embed.FS, dir string) (string, error)
• func Graph(endpoint string) http.HandlerFunc
• func Graphql(graphql embed.FS, dir string, resolver interface{}, opts ...graph.SchemaOpt) http.HandlerFunc
• func HandlerAdapter(a Adapter) http.HandlerFunc
• func HttpTracer(next http.Handler) http.Handler
• func ImgToBase64(r io.ReadCloser) (string, error)
• func JSONResponse(w http.ResponseWriter)
• func Redirect(w http.ResponseWriter, r *http.Request, url string)
• func RenderReader(r *http.Request) interface{}
• func RenderWriter(r *http.Request, value interface{})
• func RequestJSONBody(r *http.Request, extract interface{}) error
• func ResponseCSVPayload(w http.ResponseWriter, code int, rows [][]string, filename string) error
• func ResponseJSONPayload(w http.ResponseWriter, r *http.Request, code int, responses ...interface{}) error
• func SemanticVersion(r *http.Request, label string, version string)
• func SetContentType(contentType ContentType) func(next http.Handler) http.Handler
• func ToDelimited(s string, delimiter uint8) string
• func ToScreamingDelimited(s string, delimiter uint8, ignore string, screaming bool) string
• func Transport(tlsInsecure bool, timeout int) http.Client
• func Welkommen() string
• type Adapter
• type ContentType
  • func GetContentType(s string) ContentType
  • func GetRequestContentType(r *http.Request) ContentType
• type GRPCCallback
• type GRPCOpts
• type GRPCPort
• type GRpc
  • func NewServerGRPC(opts GRPCOpts) *GRpc
  • func (g *GRpc) Quiet()
  • func (g *GRpc) Run(callback GRPCCallback) error
  • func (g *GRpc) Stop()
• type Https
• type Meta
• type Pagination
  • func (p Pagination) GetLimit() int
• type Response
• type ServeOpts
• type Server
  • func NewServerMux(opts ServeOpts) *Server
  • func (s *Server) Quiet(ctx context.Context)
  • func (s *Server) Run(handler http.Handler) error
  • func (s *Server) Stop()
• type Version
• type WebPort
• type WebTimeOut

Constants

const (
	HeaderAuthorization            = "Authorization"
	HeaderContentDisposition       = "Content-Disposition"
	HeaderContentEncoding          = "Content-Encoding"
	HeaderContentLength            = "Content-Length"
	HeaderContentType              = "Content-Type"
	HeaderCookie                   = "Cookie"
	HeaderXCSRFToken               = "X-CSRF-Token"
	HeaderAccessControlAllowOrigin = "Access-Control-Allow-Origin"
	HeaderXTraceId                 = "X-Trace-Id"
	HeaderUberTraceId              = "Uber-Trace-Id"
)

const (
	MIMEApplicationJSON                  = "application/json"
	MIMEApplicationJSONCharsetUTF8       = MIMEApplicationJSON + "; " + charsetUTF8
	MIMEApplicationJavaScript            = "application/javascript"
	MIMEApplicationJavaScriptCharsetUTF8 = MIMEApplicationJavaScript + "; " + charsetUTF8
	MIMEApplicationXML                   = "application/xml"
	MIMEApplicationXMLCharsetUTF8        = MIMEApplicationXML + "; " + charsetUTF8
	MIMETextXML                          = "text/xml"
	MIMETextXMLCharsetUTF8               = MIMETextXML + "; " + charsetUTF8
	MIMEApplicationForm                  = "application/x-www-form-urlencoded"
	MIMEApplicationProtobuf              = "application/protobuf"
	MIMEApplicationMsgpack               = "application/msgpack"
	MIMETextCSV                          = "text/csv"
	MIMETextCSVCharsetUTF8               = MIMETextCSV + "; " + charsetUTF8
	MIMETextHTML                         = "text/html"
	MIMETextHTMLCharsetUTF8              = MIMETextHTML + "; " + charsetUTF8
	MIMETextPlain                        = "text/plain"
	MIMETextPlainCharsetUTF8             = MIMETextPlain + "; " + charsetUTF8
	MIMEMultipartForm                    = "multipart/form-data"
	MIMEOctetStream                      = "application/octet-stream"
	MIMEImageJPEG                        = "image/jpeg"
	MIMEImagePNG                         = "image/png"
)

MIME types

const (
	ContentTypeUnknown = iota
	ContentTypePlainText
	ContentTypeHTML
	ContentTypeJSON
	ContentTypeXML
	ContentTypeForm
	ContentTypeMultipartForm
	ContentTypeEventStream
)

ContentTypes handled by this package.

Variables

var (
	CtxResponse = ctxKeyResponse{Name: "context Respond"}
	CtxVersion  = ctxKeyVersion{Name: "context version"}
)

var (
	ContentTypeCtxKey = &ctxRender{HeaderContentType}
)

var CtxError = ctxError{Name: "context error"}

var (
	RenderContext = ctxRender{Name: "context render"}
)

var TracerContext = tracerContext{Name: "context Respond"}

Functions

func Base64ToImg

func Base64ToImg(w io.Writer, base string) (string, error)

func BindBody

func BindBody(r *http.Request, i interface{}) error

func ErrBadGateway

func ErrBadGateway(w http.ResponseWriter, r *http.Request, err error) error

ErrBadGateway error http StatusBadGateway

func ErrBadRequest

func ErrBadRequest(w http.ResponseWriter, r *http.Request, err error) error

ErrBadRequest error http StatusBadRequest

func ErrForbidden

func ErrForbidden(w http.ResponseWriter, r *http.Request, err error) error

ErrForbidden error http StatusForbidden

func ErrGatewayTimeout

func ErrGatewayTimeout(w http.ResponseWriter, r *http.Request, err error) error

ErrGatewayTimeout error http StatusGatewayTimeout

func ErrInternalServerError

func ErrInternalServerError(w http.ResponseWriter, r *http.Request, err error) error

ErrInternalServerError error http StatusInternalServerError

func ErrMethodNotAllowed

func ErrMethodNotAllowed(w http.ResponseWriter, r *http.Request, err error) error

ErrMethodNotAllowed error http StatusMethodNotAllowed

func ErrNotAcceptable

func ErrNotAcceptable(w http.ResponseWriter, r *http.Request, err error) error

ErrNotAcceptable error http StatusNotAcceptable

func ErrPaymentRequired

func ErrPaymentRequired(w http.ResponseWriter, r *http.Request, err error) error

ErrPaymentRequired error http StatusPaymentRequired

func ErrProxyAuthRequired

func ErrProxyAuthRequired(w http.ResponseWriter, r *http.Request, err error) error

ErrProxyAuthRequired error http StatusProxyAuthRequired

func ErrRequestTimeout

func ErrRequestTimeout(w http.ResponseWriter, r *http.Request, err error) error

ErrRequestTimeout error http StatusRequestTimeout

func ErrServiceUnavailable

func ErrServiceUnavailable(w http.ResponseWriter, r *http.Request, err error) error

ErrServiceUnavailable error http StatusServiceUnavailable

func ErrUnauthorized

func ErrUnauthorized(w http.ResponseWriter, r *http.Request, err error) error

ErrUnauthorized error http StatusUnauthorized

func ErrUnprocessableEntity

func ErrUnprocessableEntity(w http.ResponseWriter, r *http.Request, err error) error

ErrUnprocessableEntity error http StatusUnprocessableEntity

func ErrUnsupportedMediaType

func ErrUnsupportedMediaType(w http.ResponseWriter, r *http.Request, err error) error

ErrUnsupportedMediaType error http StatusUnsupportedMediaType

func GetIdxContentType

func GetIdxContentType(s ContentType) string

GetIdxContentType is a middleware that forces response Content-Type.

func GetRootSchema

func GetRootSchema(graphql embed.FS, dir string) (string, error)

func Graph

func Graph(endpoint string) http.HandlerFunc

Graph handler func

func Graphql

func Graphql(graphql embed.FS, dir string, resolver interface{}, opts ...graph.SchemaOpt) http.HandlerFunc

Graphql handler func

func HandlerAdapter

func HandlerAdapter(a Adapter) http.HandlerFunc

func HttpTracer

func HttpTracer(next http.Handler) http.Handler

func ImgToBase64

func ImgToBase64(r io.ReadCloser) (string, error)

func JSONResponse

func JSONResponse(w http.ResponseWriter)

JSONResponse set header content-type to json format

func Redirect

func Redirect(w http.ResponseWriter, r *http.Request, url string)

func RenderReader

func RenderReader(r *http.Request) interface{}

func RenderWriter

func RenderWriter(r *http.Request, value interface{})

func RequestJSONBody

func RequestJSONBody(r *http.Request, extract interface{}) error

RequestJSONBody get json body format

func ResponseCSVPayload

func ResponseCSVPayload(w http.ResponseWriter, code int, rows [][]string, filename string) error

ResponseCSVPayload set csv payload for response http

func ResponseJSONPayload

func ResponseJSONPayload(w http.ResponseWriter, r *http.Request, code int, responses ...interface{}) error

ResponseJSONPayload set payload for response http

func SemanticVersion

func SemanticVersion(r *http.Request, label string, version string)

func SetContentType

func SetContentType(contentType ContentType) func(next http.Handler) http.Handler

SetContentType is a middleware that forces response Content-Type.

func ToDelimited

func ToDelimited(s string, delimiter uint8) string

ToDelimited converts a string to delimited.snake.case (in this case `delimiter = '.'`)

func ToScreamingDelimited

func ToScreamingDelimited(s string, delimiter uint8, ignore string, screaming bool) string

ToScreamingDelimited converts a string to SCREAMING.DELIMITED.SNAKE.CASE (in this case `delimiter = '.'; screaming = true`) or delimited.snake.case (in this case `delimiter = '.'; screaming = false`)

func Transport

func Transport(tlsInsecure bool, timeout int) http.Client

Transport constructs a HTTP client with keep-alive turned off and a dial-timeout of 30 seconds.

func Welkommen

func Welkommen() string

Types

type Adapter

type Adapter func(w http.ResponseWriter, r *http.Request) error

type ContentType

type ContentType int

ContentType is an enumeration of common HTTP content types.

func GetContentType

func GetContentType(s string) ContentType

GetContentType is a middleware that forces response Content-Type.

func GetRequestContentType

func GetRequestContentType(r *http.Request) ContentType

GetRequestContentType is a helper function that returns ContentType based on context or request headers.

type GRPCCallback

type GRPCCallback func(*rpc.Server)

type GRPCOpts

type GRPCOpts struct {
	Port GRPCPort
	Opts []rpc.ServerOption
}

type GRPCPort

type GRPCPort int

type GRpc

type GRpc struct {
	Port GRPCPort
	Opts []rpc.ServerOption
	// contains filtered or unexported fields
}

func NewServerGRPC

func NewServerGRPC(opts GRPCOpts) *GRpc

func (*GRpc) Quiet

func (g *GRpc) Quiet()

func (*GRpc) Run

func (g *GRpc) Run(callback GRPCCallback) error

func (*GRpc) Stop

func (g *GRpc) Stop()

type Https

type Https bool

type Meta

type Meta struct {
	Code    string `json:"code,omitempty"`
	Type    string `json:"error_type,omitempty"`
	Message string `json:"error_message,omitempty"`
}

type Pagination

type Pagination struct {
	Limit      int         `json:"limit"`
	NextCursor interface{} `json:"next_cursor"`
}

func (Pagination) GetLimit

func (p Pagination) GetLimit() int

type Response

type Response struct {
	Version    interface{} `json:"version,omitempty"`
	Meta       interface{} `json:"meta,omitempty"`
	Data       interface{} `json:"data,omitempty"`
	Pagination interface{} `json:"pagination,omitempty"`
}

type ServeOpts

type ServeOpts struct {
	Port     WebPort
	TimeOut  WebTimeOut
	TLS      Https
	CertFile string
	KeyFile  string
}

type Server

type Server struct {
	Port     WebPort
	TimeOut  WebTimeOut
	TLS      Https
	CertFile string
	KeyFile  string
	// contains filtered or unexported fields
}

func NewServerMux

func NewServerMux(opts ServeOpts) *Server

func (*Server) Quiet

func (s *Server) Quiet(ctx context.Context)

func (*Server) Run

func (s *Server) Run(handler http.Handler) error

func (*Server) Stop

func (s *Server) Stop()

type Version

type Version struct {
	Label  string `json:"label,omitempty"`
	Number string `json:"number,omitempty"`
}

type WebPort

type WebPort int

type WebTimeOut

type WebTimeOut int