api

Documentation

Index

• func Register(mux *mux.Router)
• type Context
  • func (c *Context) Err(err Error)
  • func (c *Context) GetHeader(name string) string
  • func (c *Context) HTTPErr(err string, status int)
  • func (c *Context) JSON(v interface{})
  • func (c *Context) Method() string
  • func (c *Context) OK()
  • func (c *Context) SetHeader(name, value string)
  • func (c *Context) Var(name string) (ret string)
• type Err
  • func (a Err) Error() string
  • func (a Err) Status() int
• type Error

Functions

func Register

func Register(mux *mux.Router)

Register appends api handlers to the mux.Router

Types

type Context

type Context struct {
	User   string
	Admin  bool
	Body   []byte
	JWT    *jwt.Token
	Status int

	Request  *http.Request
	Response http.ResponseWriter
}

Context is the context object shared between http handlers

func (*Context) Err

func (c *Context) Err(err Error)

Err is a HTTPErr wrapper for the custom Error type

func (*Context) GetHeader

func (c *Context) GetHeader(name string) string

GetHeader returns the given http header

func (*Context) HTTPErr

func (c *Context) HTTPErr(err string, status int)

HTTPErr is a http.Error wrapper

func (*Context) JSON

func (c *Context) JSON(v interface{})

JSON is a json response

func (*Context) Method

func (c *Context) Method() string

Method returns the request method

func (*Context) OK

func (c *Context) OK()

OK is a empty HTTP 200 JSON response

func (*Context) SetHeader

func (c *Context) SetHeader(name, value string)

SetHeader sets the given http header

func (*Context) Var

func (c *Context) Var(name string) (ret string)

Var returns the given url variable

type Err

type Err struct {
	// contains filtered or unexported fields
}

Err implements the Error interface

func (Err) Error

func (a Err) Error() string

Error returns the error string

func (Err) Status

func (a Err) Status() int

Status returns the HTTP status code

type Error

type Error interface {
	Error() string
	Status() int
}

Error interface is a custom api error