api

Documentation

Overview

Package api is the atomic api helper library

Index

• func Write(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error
• func WriteJSON(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error
• func WriteXML(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error
• type Option
  • func WithAddr(addr string) Option
  • func WithAuthorizer(auth oauth.Authorizer) Option
  • func WithBasepath(base string) Option
  • func WithLogger(logger log.Interface) Option
  • func WithName(name string) Option
  • func WithRouter(router *mux.Router) Option
  • func WithVersioning(version string, serverVersion ...string) Option
• type Parameters
• type Responder
• type Response
  • func Error(e error) *Response
  • func Errorf(f string, args ...interface{}) *Response
  • func NewResponse(payload ...interface{}) *Response
  • func (r *Response) Payload() interface{}
  • func (r *Response) Status() int
  • func (r *Response) WithHeader(key string, value string) *Response
  • func (r *Response) WithStatus(status int) *Response
  • func (r *Response) WithWriter(w WriterFunc) *Response
  • func (r *Response) Write(w http.ResponseWriter) error
• type Server
  • func NewServer(opts ...Option) *Server
  • func (s *Server) AddRoute(path string, method string, params Parameters, handler interface{}, ...)
  • func (s *Server) Handler() http.Handler
  • func (s *Server) RequestVersion(r *http.Request) string
  • func (s *Server) Router() *mux.Router
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) WriteError(w http.ResponseWriter, status int, err error)
  • func (s *Server) WriteJSON(w http.ResponseWriter, status int, v interface{}, pretty ...bool)
• type WriterFunc

Functions

func Write

func Write(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

Write writes the raw payload out expeting it to be bytes

func WriteJSON

func WriteJSON(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

WriteJSON writes json objects

func WriteXML

func WriteXML(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

WriteXML writes an object out as XML

Types

type Option

type Option func(*Server)

Option provides the server options, these will override th defaults and any atomic instance values.

func WithAddr

func WithAddr(addr string) Option

WithAddr sets the listen address for the server

func WithAuthorizer

func WithAuthorizer(auth oauth.Authorizer) Option

WithAuthorizer sets the authorizer for the server

func WithBasepath

func WithBasepath(base string) Option

WithBasepath sets the router basepath for the api

func WithLogger

func WithLogger(logger log.Interface) Option

WithLogger specifies a new logger

func WithName

func WithName(name string) Option

WithName specifies the server name

func WithRouter

func WithRouter(router *mux.Router) Option

WithRouter specifies the router to use

func WithVersioning

func WithVersioning(version string, serverVersion ...string) Option

WithVersioning enables versioning that will enforce a versioned path and optionally set the Server header to the serverVersion

type Parameters

type Parameters interface {
	BindRequest(r *http.Request, c ...runtime.Consumer) error
}

Parameters interface handles binding requests

type Responder

type Responder interface {
	// Status returns the http status
	Status() int

	// Payload is the payload
	Payload() interface{}

	// Write writes ou the payload
	Write(w http.ResponseWriter) error
}

Responder is an api response interface

type Response

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

Response is the common response type

func Error

func Error(e error) *Response

Error returns an error responder

func Errorf

func Errorf(f string, args ...interface{}) *Response

Errorf returns a new error response from a string

func NewResponse

func NewResponse(payload ...interface{}) *Response

NewResponse returns a response with defaults

func (*Response) Payload

func (r *Response) Payload() interface{}

Payload returns the payload

func (*Response) Status

func (r *Response) Status() int

Status returns the status

func (*Response) WithHeader

func (r *Response) WithHeader(key string, value string) *Response

WithHeader adds headers to the request

func (*Response) WithStatus

func (r *Response) WithStatus(status int) *Response

WithStatus sets the status

func (*Response) WithWriter

func (r *Response) WithWriter(w WriterFunc) *Response

WithWriter sets the writer

func (*Response) Write

func (r *Response) Write(w http.ResponseWriter) error

Write writes the response to the writer

type Server

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

Server is an http server that provides basic REST funtionality

func NewServer

func NewServer(opts ...Option) *Server

NewServer creates a new server object

func (*Server) AddRoute

func (s *Server) AddRoute(path string, method string, params Parameters, handler interface{}, scope ...oauth.Permissions)

AddRoute adds a route in the clear

func (*Server) Handler

func (s *Server) Handler() http.Handler

Handler returns the server http handler

func (*Server) RequestVersion

func (s *Server) RequestVersion(r *http.Request) string

RequestVersion returns the request version or the server version is not found

func (*Server) Router

func (s *Server) Router() *mux.Router

Router returns the server router

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the http server

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown shuts down the http server with the context

func (*Server) WriteError

func (s *Server) WriteError(w http.ResponseWriter, status int, err error)

WriteError writes an error object

func (*Server) WriteJSON

func (s *Server) WriteJSON(w http.ResponseWriter, status int, v interface{}, pretty ...bool)

WriteJSON writes out json

type WriterFunc

type WriterFunc func(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

WriterFunc is a response writer