Echo

Echo is a fast and unfancy web framework for Go (Golang). Up to 10x faster than the rest.

This package need >= go 1.21

Features

• Optimized HTTP router which smartly prioritize routes.
• Build robust and scalable RESTful APIs.
• Run with standard HTTP server or FastHTTP server.
• Group APIs.
• Extensible middleware framework.
• Define middleware at root, group or route level.
• Handy functions to send variety of HTTP responses.
• Centralized HTTP error handling.
• Template rendering with any template engine.
• Define your format for the logger.
• Highly customizable.

Quick Start

Installation

$ go get github.com/webx-top/echo

Hello, World!

Create server.go

package main

import (
	"net/http"
	"github.com/webx-top/echo"
	"github.com/webx-top/echo/engine/standard"
)

func main() {
	e := echo.New()
	e.Get("/", func(c echo.Context) error {
		return c.String("Hello, World!", http.StatusOK)
	})
	e.Run(standard.New(":1323"))
}

Start server

$ go run server.go

Browse to http://localhost:1323 and you should see Hello, World! on the page.

Routing

e.Post("/users", saveUser)
e.Get("/users/:id", getUser)
e.Put("/users/:id", updateUser)
e.Delete("/users/:id", deleteUser)
e.Get("/user/<id:[\\d]+>", getUser)

Path Parameters

func getUser(c echo.Context) error {
	// User ID from path `users/:id`
	id := c.Param("id")
	// or id := c.Paramx("id").Uint64()
}

Query Parameters

/show?team=x-men&member=wolverine

func show(c echo.Context) error {
	// Get team and member from the query string
	team := c.Query("team")
	member := c.Query("member")
	age := c.Queryx("age").Uint()
}

Form application/x-www-form-urlencoded

POST /save

name	value
name	Joe Smith
email	[email protected]

func save(c echo.Context) error {
	// Get name and email
	name := c.Form("name")
	email := c.Form("email")
	age := c.Formx("age").Uint()
}

Form multipart/form-data

POST /save

name	value
name	Joe Smith
email	[email protected]
avatar	avatar

func save(c echo.Context) error {
	// Get name and email
	name := c.Form("name")
	email := c.Form("email")

	//------------
	// Get avatar
	//------------
	_, err := c.SaveUploadedFile("avatar","./")
	return err
}

Handling Request

• Bind JSON or XML 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"`
	Email string `json:"email" xml:"email"`
}

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

Static Content

Server any file from static directory for path /static/*.

e.Use(mw.Static(&mw.StaticOptions{
	Root:"static", //存放静态文件的物理路径
	Path:"/static/", //网址访问静态文件的路径
	Browse:true, //是否显示文件列表
}))

Middleware

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

// Group level middleware
g := e.Group("/admin")
g.Use(middleware.BasicAuth(func(username, password string) bool {
	if username == "joe" && password == "secret" {
		return true
	}
	return false
}))

// Route level middleware
track := func(next echo.HandlerFunc) echo.HandlerFunc {
	return func(c echo.Context) error {
		println("request to /users")
		return next.Handle(c)
	}
}
e.Get("/users", func(c echo.Context) error {
	return c.String("/users", http.StatusOK)
}, track)

Cookie

e.Get("/setcookie", func(c echo.Context) error {
	c.SetCookie("uid","1")
	return c.String("/setcookie: uid="+c.GetCookie("uid"), http.StatusOK)
})

Session

...
import (
	...
	"github.com/webx-top/echo/middleware/session"
	//boltStore "github.com/webx-top/echo/middleware/session/engine/bolt"
	cookieStore "github.com/webx-top/echo/middleware/session/engine/cookie"
)
...
sessionOptions := &echo.SessionOptions{
	Engine: `cookie`,
	Name:   `SESSIONID`,
	CookieOptions: &echo.CookieOptions{
		Path:     `/`,
		Domain:   ``,
		MaxAge:   0,
		Secure:   false,
		HttpOnly: true,
	},
}

cookieStore.RegWithOptions(&cookieStore.CookieOptions{
	KeyPairs: [][]byte{
		[]byte(`123456789012345678901234567890ab`),
	},
})

e.Use(session.Middleware(sessionOptions))

e.Get("/session", func(c echo.Context) error {
	c.Session().Set("uid",1).Save()
	return c.String(fmt.Sprintf("/session: uid=%v",c.Session().Get("uid")))
})

Websocket

...
import (
	...
	"github.com/admpub/websocket"
	"github.com/webx-top/echo"
	ws "github.com/webx-top/echo/handler/websocket"
)
...

e.AddHandlerWrapper(ws.HanderWrapper)

e.Get("/websocket", func(c *websocket.Conn, ctx echo.Context) error {
	//push(writer)
	go func() {
		var counter int
		for {
			if counter >= 10 { //测试只推10条
				return
			}
			time.Sleep(5 * time.Second)
			message := time.Now().String()
			ctx.Logger().Info(`Push message: `, message)
			if err := c.WriteMessage(websocket.TextMessage, []byte(message)); err != nil {
				ctx.Logger().Error(`Push error: `, err.Error())
				return
			}
			counter++
		}
	}()

	//echo
	ws.DefaultExecuter(c, ctx)
	return nil
})

More...

Sockjs

...
import (
	...
	"github.com/webx-top/echo"
	"github.com/admpub/sockjs-go/v3/sockjs"
	ws "github.com/webx-top/echo/handler/sockjs"
)
...

options := ws.Options{
	Handle: func(c sockjs.Session) error {
		//push(writer)
		go func() {
			var counter int
			for {
				if counter >= 10 { //测试只推10条
					return
				}
				time.Sleep(5 * time.Second)
				message := time.Now().String()
				log.Info(`Push message: `, message)
				if err := c.Send(message); err != nil {
					log.Error(`Push error: `, err.Error())
					return
				}
				counter++
			}
		}()

		//echo
		ws.DefaultExecuter(c)
		return nil
	},
	Options: &sockjs.DefaultOptions,
	Prefix:  "/websocket",
}
options.Wrapper(e)

More...

Other Example

package main

import (
	"net/http"

	"github.com/webx-top/echo"
	// "github.com/webx-top/echo/engine/fasthttp"
	"github.com/webx-top/echo/engine/standard"
	mw "github.com/webx-top/echo/middleware"
)

func main() {
	e := echo.New()
	e.Use(mw.Log())

	e.Get("/", func(c echo.Context) error {
		return c.String("Hello, World!")
	})
	e.Get("/echo/:name", func(c echo.Context) error {
		return c.String("Echo " + c.Param("name"))
	})
	
	e.Get("/std", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte(`standard net/http handleFunc`))
		w.WriteHeader(200)
	})

	// FastHTTP
	// e.Run(fasthttp.New(":4444"))

	// Standard
	e.Run(standard.New(":4444"))
}

See other examples...

Middleware list

Middleware	Import path	Description
BasicAuth	github.com/webx-top/echo/middleware	HTTP basic authentication
BodyLimit	github.com/webx-top/echo/middleware	Limit request body
Gzip	github.com/webx-top/echo/middleware	Send gzip HTTP response
Secure	github.com/webx-top/echo/middleware	Protection against attacks
CORS	github.com/webx-top/echo/middleware	Cross-Origin Resource Sharing
CSRF	github.com/webx-top/echo/middleware	Cross-Site Request Forgery
Log	github.com/webx-top/echo/middleware	Log HTTP requests
MethodOverride	github.com/webx-top/echo/middleware	Override request method
Recover	github.com/webx-top/echo/middleware	Recover from panics
HTTPSRedirect	github.com/webx-top/echo/middleware	Redirect HTTP requests to HTTPS
HTTPSWWWRedirect	github.com/webx-top/echo/middleware	Redirect HTTP requests to WWW HTTPS
WWWRedirect	github.com/webx-top/echo/middleware	Redirect non WWW requests to WWW
NonWWWRedirect	github.com/webx-top/echo/middleware	Redirect WWW requests to non WWW
AddTrailingSlash	github.com/webx-top/echo/middleware	Add trailing slash to the request URI
RemoveTrailingSlash	github.com/webx-top/echo/middleware	Remove trailing slash from the request URI
Static	github.com/webx-top/echo/middleware	Serve static files
MaxAllowed	github.com/webx-top/echo/middleware	MaxAllowed limits simultaneous requests; can help with high traffic load
RateLimit	github.com/webx-top/echo/middleware/ratelimit	Rate limiting HTTP requests
Language	github.com/webx-top/echo/middleware/language	Multi-language support
Session	github.com/webx-top/echo/middleware/session	Sessions Manager
JWT	github.com/webx-top/echo/middleware/jwt	JWT authentication
Markdown	github.com/webx-top/echo/middleware/markdown	Markdown rendering
Render	github.com/webx-top/echo/middleware/render	HTML template rendering
ReverseProxy	github.com/webx-top/reverseproxy	Reverse proxy

Handler Wrapper list

Wrapper	Import path	Description
Websocket	github.com/webx-top/echo/handler/websocket	Example
Sockjs	github.com/webx-top/echo/handler/sockjs	Example
Oauth2	github.com/webx-top/echo/handler/oauth2	Example
Pprof	github.com/webx-top/echo/handler/pprof	-

Cases

• Nging

Credits

• Vishal Rana - Author
• Hank Shen - Author
• Nitin Rana - Consultant
• Contributors

License

Apache 2