api

package

v2.0.0-...-caa76b4 Latest Latest Go to latest Published: Mar 6, 2024 License: CC0-1.0 Imports: 16 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 GetAllPhrasesRoute(w http.ResponseWriter, r *http.Request)

GetAllPhrasesRoute gets all the phrases for the system

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

GetRandomPhraseRoute gets a random phrase

func SetupRouter() *chi.Mux

SetupRouter sets up and returns a new chi router

func TestEndpoint(method string, endpoint string, data io.Reader, handler http.HandlerFunc, valid bool) (code int, body *bytes.Buffer, err error)

TestEndpoint allows an easy way to test HTTP end points in unit testing

type Config struct {
	AuthenticationToken string
	Port                string
	PhraseBookLocation  string
}

The Config struct holds general configuration options for the application

func LoadConfig() *Config

LoadConfig will load up a new configuration struct with sane defaults if none provided

type Pair struct {
	Esperanto string `json:"esperanto"`
	English   string `json:"english"`
}

The Pair struct provides a simple Key/Value structure of an Esperanto phrase and an English translation

func LoadPhrasebook() []Pair

LoadPhrasebook will load up the phrasebook.txt file, which is a | separated file with an Esperanto phrase and English translation on each line

func (data *Pair) Bind(r *http.Request) error

Bind allows binding the struct for use in chi render