api

package

v0.0.0-...-11c8b56 Latest Latest Go to latest Published: Jan 1, 2018 License: AGPL-3.0 Imports: 7 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

Package api has our router and HTTP handlers for all of the available api routes

This section is empty.

View Source

var Commit string

Commit this version was built against

View Source

var Version string

Version of praelatus

func New(r repo.Repo, mw middleware.Chain) http.Handler

New will start running the api on the given port

func Routes() *mux.Router

Routes will return the mux.Router which contains all of the api routes

This section is empty.

Path	Synopsis
middleware Package middleware contains the HTTP middleware used in the api as well as utility functions for interacting with them	Package middleware contains the HTTP middleware used in the api as well as utility functions for interacting with them
utils Package utils contains utility functions used throughout the api package	Package utils contains utility functions used throughout the api package
v1 Package v1 contains all of the routes and handlers for v1 of the API	Package v1 contains all of the routes and handlers for v1 of the API