httpserver

Documentation

Index

• func OperationWrapper(op operations.Operation) fasthttp.RequestHandler
• type Config
• type Endpoint
• type ErrorResponse
  • func NewErrorResponse(errorCode, message string) ErrorResponse
• type OperationAPI
• type Request
• type Server
  • func NewServer(ops map[string]operations.Operation) Server

Functions

func OperationWrapper

func OperationWrapper(op operations.Operation) fasthttp.RequestHandler

Types

type Config

type Config struct {
	Port               int
	Address            string
	MaxRequestBodySize int
	UnixDomainSocket   string
	ReadBufferSize     int
	APILogging         bool
}

type Endpoint

type Endpoint struct {
	Method    string
	Route     string
	Version   string
	Duplicate string
	Handler   fasthttp.RequestHandler
}

type ErrorResponse

type ErrorResponse struct {
	ErrorCode string `json:"errorCode"`
	Message   string `json:"message"`
}

ErrorResponse is an HTTP response message sent back to calling clients.

func NewErrorResponse

func NewErrorResponse(errorCode, message string) ErrorResponse

NewErrorResponse returns a new ErrorResponse.

type OperationAPI

type OperationAPI interface {
	Endpoints() []Endpoint
	RegisterOperations(map[string]operations.Operation)
}

type Request

type Request struct {
	Data       interface{}    `json:"data,omitempty"`
	Parameters map[string]any `json:"parameters,omitempty"`
}

type Server

type Server interface {
	io.Closer
	Router() fasthttp.RequestHandler
	StartNonBlocking() error
}

Server is an interface for the Lorry HTTP server.

func NewServer

func NewServer(ops map[string]operations.Operation) Server

NewServer returns a new HTTP server.