rocket

README

rocket

Rocket is a web framework inspired by rocket-rs.

Install

go get github.com/dannypsnl/rocket

Document

https://dannypsnl.github.io/rocket

Documentation

Index

• Constants
• func AuthError(format string, a ...interface{}) *response.Response
• func Delete(route string, do interface{}) *handler
• func Get(route string, do interface{}) *handler
• func Patch(route string, do interface{}) *handler
• func Post(route string, do interface{}) *handler
• func Put(route string, do interface{}) *handler
• func ValidateError(format string, a ...interface{}) *response.Response
• type DefaultFairing
  • func (f DefaultFairing) OnLaunch(*Rocket)
  • func (f DefaultFairing) OnRequest(req *http.Request) *http.Request
  • func (f DefaultFairing) OnResponse(resp *response.Response) *response.Response
• type Fairing
• type Guard
• type Rocket
  • func Ignite(port int) *Rocket
  • func (rk *Rocket) Attach(f Fairing) *Rocket
  • func (rk *Rocket) Default(do interface{}) *Rocket
  • func (rk *Rocket) EnableHTTPs(certFile, keyFile string) *Rocket
  • func (rk *Rocket) Launch()
  • func (rk *Rocket) Mount(handlers ...*handler) *Rocket
  • func (rk *Rocket) OnClose(f func() error) *Rocket
  • func (rk *Rocket) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const ErrorMessageForMethodNotAllowed = "request resource does not support http method '%s'"

Functions

func AuthError

func AuthError(format string, a ...interface{}) *response.Response

func Delete

func Delete(route string, do interface{}) *handler

Delete return delete handler.

func Get

func Get(route string, do interface{}) *handler

Get return a get handler.

func Patch

func Patch(route string, do interface{}) *handler

Patch return a patch handler.

func Post

func Post(route string, do interface{}) *handler

Post return a post handler.

func Put

func Put(route string, do interface{}) *handler

Put return a put handler.

func ValidateError

func ValidateError(format string, a ...interface{}) *response.Response

Types

type DefaultFairing

type DefaultFairing struct{}

DefaultFairing provides default implement for your fairing by embedded it into your fairing type, Embedded is a good practice because fairing is designed to allowed partial implement interface

func (DefaultFairing) OnLaunch

func (f DefaultFairing) OnLaunch(*Rocket)

func (DefaultFairing) OnRequest

func (f DefaultFairing) OnRequest(req *http.Request) *http.Request

func (DefaultFairing) OnResponse

func (f DefaultFairing) OnResponse(resp *response.Response) *response.Response

type Fairing

type Fairing interface {
	OnRequest(*http.Request) *http.Request
	OnResponse(*response.Response) *response.Response
	// OnLaunch would let you could get the metadata of rocket server
	//
	// NOTE: only work when you using `Launch()` to start server
	// won't work while you use rocket as HTTP handler
	OnLaunch(*Rocket)
}

Fairing specify the method that fairing could implement

type Guard

type Guard interface {
	VerifyRequest() *response.Response
}

Guard is an interface that context can implement, when context implement this, context can reject request with a *response.Response.

type Rocket

type Rocket struct {

	// MultiFormBodySizeLimit decide the multiple forms value size
	MultiFormBodySizeLimit int64
	// contains filtered or unexported fields
}

Rocket is our service.

func Ignite

func Ignite(port int) *Rocket

Ignite initial service by port.

func (*Rocket) Attach

func (rk *Rocket) Attach(f Fairing) *Rocket

Attach add fairing to lifecycle for each request and response

func (*Rocket) Default

func (rk *Rocket) Default(do interface{}) *Rocket

Default receive a function that have signature `func() <T>` for custom response when no route matched, <T> means a legal response Type of rocket, e.g. `*response.Response`, `response.Json` by default that(status code 404) would returns `"page not found"` when no set this function,

func (*Rocket) EnableHTTPs

func (rk *Rocket) EnableHTTPs(certFile, keyFile string) *Rocket

EnableHTTPs would get certFile and keyFile to enable HTTPs

func (*Rocket) Launch

func (rk *Rocket) Launch()

Launch shoot our service.(start server)

func (*Rocket) Mount

func (rk *Rocket) Mount(handlers ...*handler) *Rocket

Mount add handlers into our service.

func (*Rocket) OnClose

func (rk *Rocket) OnClose(f func() error) *Rocket

OnClose takes a function f and runs it after server closed

func (*Rocket) ServeHTTP

func (rk *Rocket) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is prepare for http server trait, so that you could use `*rocket.Rocket` as `http.Handler`