express

Documentation

Index

• type Express
  • func NewExpress(_options *options.Config) *Express
  • func (es *Express) AuthorizeRequests(handle httprouter.Handle) httprouter.Handle
  • func (es *Express) CanAccess(r *http.Request, router httprouter.Params) bool
  • func (es *Express) GetAppId(router httprouter.Params) string
  • func (es *Express) GetAuthKey(r *http.Request) string
  • func (es *Express) Route() *httprouter.Router
  • func (es *Express) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (es *Express) UnauthorizedResponse(w http.ResponseWriter, r *http.Request)
  • func (es *Express) Use(middlewares ...Next)
• type Next

Types

type Express

type Express struct {
	*types.ServeMux
	// contains filtered or unexported fields
}

func NewExpress

func NewExpress(_options *options.Config) *Express

Create a new Express instance.

func (*Express) AuthorizeRequests

func (es *Express) AuthorizeRequests(handle httprouter.Handle) httprouter.Handle

Attach global protection to HTTP routes, to verify the API key.

func (*Express) CanAccess

func (es *Express) CanAccess(r *http.Request, router httprouter.Params) bool

Check is an incoming r can access the api.

func (*Express) GetAppId

func (es *Express) GetAppId(router httprouter.Params) string

Get the appId from the URL

func (*Express) GetAuthKey

func (es *Express) GetAuthKey(r *http.Request) string

Get the api token from the r.

func (*Express) Route

func (es *Express) Route() *httprouter.Router

func (*Express) ServeHTTP

func (es *Express) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Express) UnauthorizedResponse

func (es *Express) UnauthorizedResponse(w http.ResponseWriter, r *http.Request)

Handle unauthorized rs.

func (*Express) Use

func (es *Express) Use(middlewares ...Next)

type Next

type Next func(http.ResponseWriter, *http.Request, func())