Echo framework

Echo website

Echo - High performance, minimalist Go web framework

Echo is a high performance, extensible, minimalist web framework for Go (Golang).

https://echo.labstack.com/

Features I liked about Echo

1. Middleware

1. Data binding

Tutorial

Guide | Echo - High performance, minimalist Go web framework

To install Echo Go v1.13 or higher is required. Go v1.12 has limited support and some middlewares will not be available. Make sure your project folder is outside your $GOPATH. If you are working with Go v1.14 or earlier use: Create server.go Start server Browse to http://localhost:1323 and you should see Hello, World!

https://echo.labstack.com/guide/

Routing

e.POST("/users", saveUser)
e.GET("/users/:id", getUser)
e.PUT("/users/:id", updateUser)
e.DELETE("/users/:id", deleteUser)

Get :id by Param

// e.GET("/users/:id", getUser)
func getUser(c echo.Context) error {
  	// User ID from path `users/:id`
  	id := c.Param("id")
	return c.String(http.StatusOK, id)
}

Query parameters

//e.GET("/show", show)
func show(c echo.Context) error {
	// Get team and member from the query string
	team := c.QueryParam("team")
	member := c.QueryParam("member")
	return c.String(http.StatusOK, "team:" + team + ", member:" + member)
}

Post

Form application/x-www-form-urlencoded

// e.POST("/save", save)
func save(c echo.Context) error {
	// Get name and email
	name := c.FormValue("name")
	email := c.FormValue("email")
	return c.String(http.StatusOK, "name:" + name + ", email:" + email)
}

Form multipart/form-data

func save(c echo.Context) error {
	// Get name
	name := c.FormValue("name")
	// Get avatar
  	avatar, err := c.FormFile("avatar")
  	if err != nil {
 		return err
 	}
 
 	// Source
 	src, err := avatar.Open()
 	if err != nil {
 		return err
 	}
 	defer src.Close()
 
 	// Destination
 	dst, err := os.Create(avatar.Filename)
 	if err != nil {
 		return err
 	}
 	defer dst.Close()
 
 	// Copy
 	if _, err = io.Copy(dst, src); err != nil {
  		return err
  	}

	return c.HTML(http.StatusOK, "<b>Thank you! " + name + "</b>")
}

Handling request

• Bind json, xml, form or query payload into Go struct based on Content-Type request header.

• Render response as json or xml with status code.

type User struct {
	Name  string `json:"name" xml:"name" form:"name" query:"name"`
	Email string `json:"email" xml:"email" form:"email" query:"email"`
}

e.POST("/users", func(c echo.Context) error {
	u := new(User)
	if err := c.Bind(u); err != nil {
		return err
	}
	return c.JSON(http.StatusCreated, u)
	// or
	// return c.XML(http.StatusCreated, u)
})

Middleware

Middleware | Echo - High performance, minimalist Go web framework

Middleware is a function chained in the HTTP request-response cycle with access to Echo#Context which it uses to perform a specific action, for example, logging every request or limiting the number of requests. Handler is processed in the end after all middleware are finished executing.

https://echo.labstack.com/middleware/

// Root level middleware
e.Use(middleware.Logger())
e.Use(middleware.Recover())

Response

JSON response

Response | Echo - High performance, minimalist Go web framework

Context#String(code int, s string) can be used to send plain text response with status code. Context#HTML(code int, html string) can be used to send simple HTML response with status code. If you are looking to send dynamically generate HTML see templates. Context#HTMLBlob(code int, b []byte) can be used to send HTML blob with status code.

https://echo.labstack.com/guide/response/#send-json

// User
type User struct {
  Name  string `json:"name" xml:"name"`
  Email string `json:"email" xml:"email"`
}

// Handler
func(c echo.Context) error {
  u := &User{
    Name:  "Jon",
    Email: "jon@labstack.com",
  }
  return c.JSON(http.StatusOK, u)
}

Stream JSON ?

Pretty

Jaeger

Prometheus

Timeout

Timeout Middleware | Echo - High performance, minimalist Go web framework

Timeout middleware is used to timeout at a long running operation within a predefined period. e.Use(middleware.Timeout()) TimeoutErrorHandlerWithContext is responsible for handling the errors when a timeout happens Default Configuration Caught a mistake? Edit this page on GitHub!

https://echo.labstack.com/middleware/timeout/

e := echo.New()
e.Use(middleware.TimeoutWithConfig(middleware.TimeoutConfig{
  Skipper: Skipper,
  ErrorHandler: func(err error, e echo.Context) error {
      // you can handle your error here, the returning error will be 
      // passed down the middleware chain
      return err
  },
  Timeout: 30*time.Second,
}))

Rate limiter

Rate Limiter Middleware | Echo - High performance, minimalist Go web framework

RateLimiter provides a Rate Limiter middleware for limiting the amount of requests to the server from a particular IP or id within a time period. By default an in-memory store is used for keeping track of requests.

https://echo.labstack.com/middleware/rate-limiter/

e.Use(middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(20)))

Secure

Secure Middleware | Echo - High performance, minimalist Go web framework

Secure middleware provides protection against cross-site scripting (XSS) attack, content type sniffing, clickjacking, insecure connection and other code injection attacks. e.Use(middleware.Secure()) Passing empty XSSProtection, ContentTypeNosniff, XFrameOptions or ContentSecurityPolicy disables that protection. // Skipper defines a function to skip middleware.

https://echo.labstack.com/middleware/secure/