api

package

v0.0.0-...-5c7a00c Latest Latest Go to latest Published: Nov 15, 2023 License: MIT Imports: 14 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 SetRoutes(db *sql.DB, h *ws.Hub) *chi.Mux

SetRoutes will instantiate the REST routes

type API struct {
	APIConfig  *config.APIConfig
	DB         *sql.DB
	HTTPServer *http.Server
	Hub        *ws.Hub
}

API holds the relevant information of the backend API

func SetupAPI(db *sql.DB, APIConfig *config.APIConfig) *API

SetupAPI will instantiate an API and return it

func (a *API) Start()

Start will start the backend API

Path	Synopsis
routes