api

package

v0.0.0-...-c2c271f Latest Latest Go to latest Published: Nov 1, 2016 License: MIT Imports: 13 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

View Source

const (
	JsonContentTypeKey   = "Content-Type"
	JsonContentTypeValue = "application/json"
)

This section is empty.

func AttachMiddleware(h http.Handler, middlewares ...Middleware) http.Handler

type Api struct {
	Config   *config.Config
	Database *database.Database
	Logger   *logger.Logger
	Router   *mux.Router
	Writer   io.Writer
}

func New() *Api

func (a *Api) ConfigWith(filePath string) error

func (a *Api) Route(path string, sr Subrouter)

func (a *Api) Serve()

func (a *Api) Shutdown()

type JsonError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

func (e JsonError) Error() string

func (e JsonError) String() string

type Middleware func(http.Handler) http.Handler

func Catch404Handler() Middleware

func LoggingHandler(out io.Writer) Middleware

type ServiceProvider interface {
	ConfigWith(string) error
	Serve()
	Shutdown()
}

type Subroute struct {
	Config   *config.Config
	Database *database.Database
	Logger   *logger.Logger
	Router   *mux.Router
}

func (sr *Subroute) ConfigWith(r *mux.Router, d *database.Database, c *config.Config, l *logger.Logger)

func (sr *Subroute) JsonBaseHandler(w http.ResponseWriter, r *http.Request, code int, data interface{})

func (sr *Subroute) JsonInternalErrorHandler(w http.ResponseWriter, r *http.Request, err error)

func (sr *Subroute) JsonNotFoundHandler(w http.ResponseWriter, r *http.Request, err error)

func (sr *Subroute) JsonResponseHandler(w http.ResponseWriter, r *http.Request, data interface{})

type Subrouter interface {
	ConfigWith(*mux.Router, *database.Database, *config.Config, *logger.Logger)
	Handle()
}

type Version1 struct {
	Subroute
}

func (v1 *Version1) Handle()