common

Documentation

Overview

Code generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.

Index

• Variables
• func AssertRecurseInterfaceRequired(obj interface{}, callback func(interface{}) error) error
• func AssertRecurseValueRequired(value reflect.Value, callback func(interface{}) error) error
• func AuthnMiddleware(next http.Handler, jwtKeys interface{}, authnRequired bool) http.Handler
• func DefaultErrorHandler(w http.ResponseWriter, r *http.Request, err error, result *ImplResponse)
• func EncodeJSONResponse(i interface{}, status *int, headers map[string][]string, w http.ResponseWriter)
• func IsZeroValue(val interface{}) bool
• func Logger(inner http.Handler, name string) http.Handler
• func NewRouter(jwtKeys interface{}, routers ...Router) *mux.Router
• func ReadFormFileToTempFile(r *http.Request, key string) (*os.File, error)
• func ReadFormFilesToTempFiles(r *http.Request, key string) ([]*os.File, error)
• type AuthContext
• type AuthContextLabel
• type BasicAuthCredentials
• type ErrorHandler
• type ImplResponse
  • func Response(code int, body interface{}) ImplResponse
  • func ResponseWithHeaders(code int, headers map[string][]string, body interface{}) ImplResponse
• type ParsingError
  • func (e *ParsingError) Error() string
  • func (e *ParsingError) Unwrap() error
• type RequiredError
  • func (e *RequiredError) Error() string
• type Route
• type Router
• type Routes

Variables

var (
	// ErrTypeAssertionError is thrown when type an interface does not match the asserted type
	ErrTypeAssertionError = errors.New("unable to assert type")
)

Functions

func AssertRecurseInterfaceRequired

func AssertRecurseInterfaceRequired(obj interface{}, callback func(interface{}) error) error

AssertRecurseInterfaceRequired recursively checks each struct in a slice against the callback. This method traverse nested slices in a preorder fashion.

func AssertRecurseValueRequired

func AssertRecurseValueRequired(value reflect.Value, callback func(interface{}) error) error

AssertRecurseValueRequired checks each struct in the nested slice against the callback. This method traverse nested slices in a preorder fashion.

func AuthnMiddleware

func AuthnMiddleware(next http.Handler, jwtKeys interface{}, authnRequired bool) http.Handler

func DefaultErrorHandler

func DefaultErrorHandler(w http.ResponseWriter, r *http.Request, err error, result *ImplResponse)

DefaultErrorHandler defines the default logic on how to handle errors from the controller. Any errors from parsing request params will return a StatusBadRequest. Otherwise, the error code originating from the servicer will be used.

func EncodeJSONResponse

func EncodeJSONResponse(i interface{}, status *int, headers map[string][]string, w http.ResponseWriter)

EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code

func IsZeroValue

func IsZeroValue(val interface{}) bool

IsZeroValue checks if the val is the zero-ed value.

func Logger

func Logger(inner http.Handler, name string) http.Handler

func NewRouter

func NewRouter(jwtKeys interface{}, routers ...Router) *mux.Router

NewRouter creates a new router for any number of api routers

func ReadFormFileToTempFile

func ReadFormFileToTempFile(r *http.Request, key string) (*os.File, error)

ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file

func ReadFormFilesToTempFiles

func ReadFormFilesToTempFiles(r *http.Request, key string) ([]*os.File, error)

ReadFormFilesToTempFiles reads files array data from a request form and writes it to a temporary files

Types

type AuthContext

type AuthContext struct {
	UserCredentials *BasicAuthCredentials
	ParsedJWT       *jwt.JSONWebToken
}

type AuthContextLabel

type AuthContextLabel string

const (
	AuthContextKey AuthContextLabel = "AuthContext"
)

type BasicAuthCredentials

type BasicAuthCredentials struct {
	Username string
	Password string
}

type ErrorHandler

type ErrorHandler func(w http.ResponseWriter, r *http.Request, err error, result *ImplResponse)

ErrorHandler defines the required method for handling error. You may implement it and inject this into a controller if you would like errors to be handled differently from the DefaultErrorHandler

type ImplResponse

type ImplResponse struct {
	Code    int
	Headers map[string][]string
	Body    interface{}
}

ImplResponse response defines an error code with the associated body

func Response

func Response(code int, body interface{}) ImplResponse

Response return a ImplResponse struct filled

func ResponseWithHeaders

func ResponseWithHeaders(code int, headers map[string][]string, body interface{}) ImplResponse

ResponseWithHeaders return a ImplResponse struct filled, including headers

type ParsingError

type ParsingError struct {
	Err error
}

ParsingError indicates that an error has occurred when parsing request parameters

func (*ParsingError) Error

func (e *ParsingError) Error() string

func (*ParsingError) Unwrap

func (e *ParsingError) Unwrap() error

type RequiredError

type RequiredError struct {
	Field string
}

RequiredError indicates that an error has occurred when parsing request parameters

func (*RequiredError) Error

func (e *RequiredError) Error() string

type Route

type Route struct {
	Name          string
	Method        string
	Pattern       string
	HandlerFunc   http.HandlerFunc
	AuthnRequired bool
}

A Route defines the parameters for an api endpoint

type Router

type Router interface {
	Routes() Routes
}

Router defines the required methods for retrieving api routes

type Routes

type Routes []Route

Routes are a collection of defined api endpoints