web

Documentation

Index

• Variables
• func GetTLSConfig() (config *tls.Config, err error)
• type AppContext
  • func NewContext(r *repo.Repo) *AppContext
• type Error
  • func (e *Error) Error() string
• type Errors
• type Router
  • func New(appC *AppContext) *Router
  • func (r *Router) Delete(path string, handler http.Handler)
  • func (r *Router) Get(path string, handler http.Handler)
  • func (r *Router) Post(path string, handler http.Handler)
  • func (r *Router) Put(path string, handler http.Handler)
  • func (r *Router) Serve()

Variables

var (
	// ErrOK is returned for successful operations
	ErrOK = &Error{ID: "success", Status: 200}
	// ErrBadRequest is a generic bad request
	ErrBadRequest = &Error{"bad_request", 400, "Bad request", "Request body is not well-formed. It must be JSON."}
	// ErrAuth if not authenticated
	ErrAuth = &Error{"unauthorized", 401, "Unauthorized", "The request requires authorization"}
	// ErrCredentials if there are missing / wrong credentials
	ErrCredentials = &Error{"invalid_credentials", 401, "Invalid credentials", "Invalid username or password"}
	// ErrNotAcceptable wrong accept header
	ErrNotAcceptable = &Error{"not_acceptable", 406, "Not Acceptable", "Accept header must be set to 'application/json'."}
	// ErrUnsupportedMediaType wrong media type
	ErrUnsupportedMediaType = &Error{"unsupported_media_type", 415, "Unsupported Media Type", "Content-Type header must be set to: 'application/json'."}
	// ErrInternalServer if things go wrong on our side
	ErrInternalServer = &Error{"internal_server_error", 500, "Internal Server Error", "Something went wrong."}
)

Functions

func GetTLSConfig

func GetTLSConfig() (config *tls.Config, err error)

GetTLSConfig ...

Types

type AppContext

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

AppContext holds the web context for the handlers

func NewContext

func NewContext(r *repo.Repo) *AppContext

NewContext creates a new context

type Error

type Error struct {
	ID     string `json:"id"`
	Status int    `json:"status"`
	Title  string `json:"title,omitempty"`
	Detail string `json:"detail,omitempty"`
}

Error holds the info about a web error

func (*Error) Error

func (e *Error) Error() string

type Errors

type Errors struct {
	Errors []*Error `json:"errors"`
}

Errors is a list of errors

type Router

type Router struct {
	*httprouter.Router
	// contains filtered or unexported fields
}

Router handles the web requests routing

func New

func New(appC *AppContext) *Router

New creates a new router

func (*Router) Delete

func (r *Router) Delete(path string, handler http.Handler)

Delete handles DELETE requests

func (*Router) Get

func (r *Router) Get(path string, handler http.Handler)

Get handles GET requests

func (*Router) Post

func (r *Router) Post(path string, handler http.Handler)

Post handles POST requests

func (*Router) Put

func (r *Router) Put(path string, handler http.Handler)

Put handles PUT requests

func (*Router) Serve

func (r *Router) Serve()

Serve - creates the relevant listeners