api

package

v0.0.0-...-56c67ce Latest Latest Go to latest Published: Aug 27, 2021 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func NewRouter() *mux.Router

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

PingHandler will handle the ping route

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

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

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

Generic API error swagger:response genericError

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

Ping response payload swagger:response pingResponse

type TestSuite struct {
	suite.Suite
}

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

func (suite *TestSuite) TestPing()