Not a Framework

nf is a Go package designed to aid us in building HTTP services at IMQS. It is IMQS specific - tying into our authentication service, our logging, etc.

nf/nfdb contains helpers for SQL databases
nf/nftest contains helpers for building unit tests

See godoc documentation at nf, nfdb, nftest

Examples

See github.com/IMQS/gostarter for a real-world example.

HTTP Handlers

The functions Handle and HandleAuthenticated create an HTTP API entrypoint handler. Your handler function is free to panic inside these handlers, an the panic will be interpreted by the wrapper, and an appropriate HTTP error code sent back to the caller.

If you call nf.Panic(403, "Operation not allowed"), then the caller will receive the intended response.

Testing

Before running nfdb tests, you must start a Postgres instance, for example:

docker run --rm -p 5432:5432 imqs/postgres:unittest-10.5

And then, to test, for example:

go test github.com/IMQS/nf/nfdb