gobstopper

gobstopper

An idiomatic framework for creating web stacks in Golang.

version 3.0

Goals

• Well chosen stack of core components
• Exposed core components for ultimate flexibility
• Convenience functions for adding routes, middleware and route groups for those looking to get going fast
• DB connection magically available in all handlers and middleware

Usage

Basic

conf := gobstopper.Config{
  Port: 8000,
  PathPrefix: "/v1",
}

server, err := gobstopper.NewServer(conf)
if err != nil {
  log.Fatal("Unable to start server!")
}


server.Route(gobstopper.Route{
  Method: "GET",
  Path:   "/foo",
  Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "hello")
  }),
})

server.Start()

Route Groups

server.RouteGroup("/admin", func(group *gobstopper.Group) {
  group.Middleware(middleware.TerribleAuthMiddleware)
  group.Route(gobstopper.Route{
    Method: "GET",
    Path:   "",
    Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
      fmt.Fprintln(w, "admin")
    }),
  })
})

Config

For full details of the server configuration.

Database Connection

Gobstopper will make your sqlx DB connection pool available to you in all your middleware and handlers.

// Route handler...
func ServeHTTP(w http.ResponseWriter, r *http.Request) {
	db := database.GetConnection(r)
  // You can use it from here on...
}

Under The Hood

mux - Router

The name mux stands for "HTTP request multiplexer". Like the standard http.ServeMux, mux.Router matches incoming requests against a list of registered routes and calls a handler for the route that matches the URL or other conditions.

negroni - Middleware Manager

Negroni is an idiomatic approach to web middleware in Go. It is tiny, non-intrusive, and encourages use of net/http Handlers.

sqlx - Database (optional)

sqlx is a library which provides a set of extensions on go's standard database/sql library. The sqlx versions of sql.DB, sql.TX, sql.Stmt, et al. all leave the underlying interfaces untouched, so that their interfaces are a superset on the standard ones.

Contributing

See an issue? Submit a ticket.

This project aims to have unit tests with 100% code coverage. All PRs should have full tests included with them. To run the tests...

go test -v ./...