restokit

Documentation

Index

• func TeardownHTTP(r *Restokit) error
• type Middleware
• type Restokit
  • func NewRestokit(addr string) *Restokit
  • func ScaffoldHTTP() (*Restokit, *http.Client)
  • func (r *Restokit) AddGlobalMiddleware(fn Middleware)
  • func (r *Restokit) Start() error

Functions

func TeardownHTTP

func TeardownHTTP(r *Restokit) error

TeardownHTTP for cleanup of test scaffolding

Types

type Middleware

type Middleware func(fasthttp.RequestHandler) fasthttp.RequestHandler

type Restokit

type Restokit struct {
	Router   *fasthttprouter.Router
	Server   *fasthttp.Server
	Listener net.Listener
	Logger   *logrus.Entry

	HealthCheck    fasthttp.RequestHandler
	ReadinessCheck fasthttp.RequestHandler
	// contains filtered or unexported fields
}

Restokit is the REST framework common building block. The system involves simple codegen tricks.

func NewRestokit

func NewRestokit(addr string) *Restokit

NewRestokit creates a new restokit with the specified address

func ScaffoldHTTP

func ScaffoldHTTP() (*Restokit, *http.Client)

ScaffoldHTTP creates an in-memory listener restokit with http client.

func (*Restokit) AddGlobalMiddleware

func (r *Restokit) AddGlobalMiddleware(fn Middleware)

AddGlobalMiddleware to the middleware stack. Only works before starting.

func (*Restokit) Start

func (r *Restokit) Start() error

Start starts the server as built.