api

Documentation

Index

• func NewRouter() *mux.Router
• func PingHandler(w http.ResponseWriter, r *http.Request)
• func Respond(w http.ResponseWriter, status int, v interface{}) error
• func RespondError(w http.ResponseWriter, status int, err error)
• type GenericError
• type PingResponse
• type TestSuite
  • func (suite *TestSuite) ExecuteRequest(router *mux.Router, req *http.Request) *httptest.ResponseRecorder
  • func (suite *TestSuite) TestPing()

Functions

func NewRouter

func NewRouter() *mux.Router

func PingHandler

func PingHandler(w http.ResponseWriter, r *http.Request)

PingHandler will handle the ping route

func Respond

func Respond(w http.ResponseWriter, status int, v interface{}) error

func RespondError

func RespondError(w http.ResponseWriter, status int, err error)

Types

type GenericError

type GenericError struct {
	// Message describing the error
	Error string `json:"error"`
}

Generic API error swagger:response genericError

type PingResponse

type PingResponse struct {
	// The pong generation time (in UTC)
	Pong time.Time `json:"pong"`
}

Ping response payload swagger:response pingResponse

type TestSuite

type TestSuite struct {
	suite.Suite
}

func (*TestSuite) ExecuteRequest

func (suite *TestSuite) ExecuteRequest(router *mux.Router, req *http.Request) *httptest.ResponseRecorder

func (*TestSuite) TestPing

func (suite *TestSuite) TestPing()