server

Documentation

Index

• Constants
• type APIServer
  • func NewAPIServer(database db.Database) *APIServer
  • func (srv *APIServer) Run(bindAddress string) error
• type APIServerRootResponse

Constants

const (
	// DatabaseStatusOffline indicates that the database cannot be reached.
	DatabaseStatusOffline = "OFFLINE"
	// DatabaseStatusOnline indicates that the database can be reached.
	DatabaseStatusOnline = "ONLINE"
)

Types

type APIServer

type APIServer struct {
	// contains filtered or unexported fields
}

APIServer serves APIs such as the Payments API.

func NewAPIServer

func NewAPIServer(database db.Database) *APIServer

NewAPIServer returns a new instance of the API server that uses the specified database for storage.

func (*APIServer) Run

func (srv *APIServer) Run(bindAddress string) error

Run runs the API server at the specified address.

type APIServerRootResponse

type APIServerRootResponse struct {
	// DatabaseStatus is the current status of the database.
	DatabaseStatus string `json:"database_status"`
	// Timestamp is the current timestamp.
	Timestamp time.Time `json:"time"`
}

APIServerRootResponse represents a response returned by the root handler.