echo/website/content/guide/request.md

+++ title = "HTTP Request" description = "Handling HTTP request in Echo" [menu.side] name = "Request" parent = "guide" weight = 6 +++

Request

Bind Request Body

To bind request body into a provided Go type use Context#Bind(interface{}). The default binder supports decoding application/json, application/xml and application/x-www-form-urlencoded payload based on Context-Type header.

Example

TODO

Custom binder can be registered via Echo#SetBinder(Binder)

Query Parameter

Query parameter can be retrieved by name using Context#QueryParam(name string).

Example

e.GET("/users", func(c echo.Context) error {
	name := c.QueryParam("name")
	return c.String(http.StatusOK, name)
})

$ curl -G -d "name=joe" http://localhost:1323/users

Form Parameter

Form parameter can be retrieved by name using Context#FormValue(name string).

Example

e.POST("/users", func(c echo.Context) error {
	name := c.FormValue("name")
	return c.String(http.StatusOK, name)
})

$ curl -d "name=joe" http://localhost:1323/users

Path Parameter

Registered path parameter can be retrieved either by name Context#Param(name string) string or by index Context#P(i int) string. Getting parameter by index gives a slightly better performance.

Example

e.GET("/users/:name", func(c echo.Context) error {
	// By name
	name := c.Param("name")

	// By index
	name := c.P(0)

	return c.String(http.StatusOK, name)
})

$ curl http://localhost:1323/users/joe

Handler Path

Context#Path() returns the registered path for the handler, it can be used in the middleware for logging purpose.

Example

e.Use(func(c echo.Context) error {
    println(c.Path()) // Prints `/users/:name`
    return nil
})
e.GET("/users/:name", func(c echo.Context) error) {
    return c.String(http.StatusOK, name)
})