uf

Overview ¶

A set of utility functions and a router provided by HTTPRouter (https://github.com/julienschmidt/httprouter).

Example:

import (

"github.com/blacksfk/uf"
// ...

)

func main() {
	// create a new server
	config := &uf.Config{...}

	// middlewareX and Y are middleware that will be applied to every route defined
	server := uf.NewServer(config, middlewareX, middlewareY, ...)

	// configure CORS or any other settings exported by HTTPRouter
	server.GlobalOPTIONS = func(w http.ResponseWriter, r *http.Request) {
		if r.Header.Get("Access-Control-Request-Method") != "" {
			h := w.Header()

			h.Set("Access-Control-Allow-Methods", header.Get("Allow"))
			h.Set("Access-Control-Allow-Origin", "example.com")

			// ...
		}

		// reply to options
		w.WriteHeader(http.StatusNoContent)
	}

	// add routes to the server (supports GET, POST, PUT, PATCH, DELETE convenience methods)
	// middleware functions X, Y, A, B, C will be called before the handler in order
	server.Get("/book", handler, middlewareA, middlewareB, middlewareC)

	// ...

	// add route groups to the server
	// middleware functions X, Y, A, B will be called in order before each middleware
	// and handler defined below
	server.Group("/author", middlewareA, middlewareB).

		// middlewareC will be called after X, Y, A, and B but only for GET requests on this route
		Get(author.HandleGet, middlewareC).

		// middlewareD will be called after X, Y, A, and B for the following route definitions
		Middleware(middlewareD).
		Post(author.HandlePost).
		Put(author.HandlePut).

		// middlewareE will be called after X, Y, A, B, and D but only for PATCH
		// requests on this route
		Patch(author.HandlePatch, middlewareE).
		Delete(author.HandleDelete)

	// start the server
	e := http.ListenAndServe("localhost:6060", server)

	// ...
}

func handler(w http.ResponseWriter, r *http.Request) error {
	books := database.ObtainBooks()

	return uf.SendJSON(w, books)
}

func middlewareA(r *http.Request) error {
	// get the auth key and user (somehow)
	key := r.Header.Get("Authorization")
	user := database.FindUser()

	if !user.Valid(key) {
		// user needs to re-authenticate
		return uf.Unauthorized("Invalid login")
	}

	// authenticated
	*r = *r.WithContext(user.ToContext(r.Context()))

	// progress to next handler
	return nil
}