Context

Context (Ctx) holds the HTTP request, response and provide methods

Allows you to use all Fasthttp methods and properties (check Fasthttp Documentation for more information)

Context() *fasthttp.RequestCtx

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    ctx.Context().Response.SetBodyString("Hello World!")
})

Returns value of path parameter specified by key in request

Param(key string) string

Example

gb.Get("/users/:user", func(ctx gearbox.Context) {
    fmt.Printf("%s\n", ctx.Param("user"))
})

Sets the body of response for bytes type

SendBytes(value []byte) Context

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    ctx.SendBytes([]byte("Hello World!"))
})

Sets the body of response for string type

SendString(value string) Context

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    ctx.SendString("Hello World!")
})

Sets the body of response for any interface after converting any interface to json and sets content type header to application/json

SendJSON(in interface{}) error

Example

type Response struct {
    Value string
}

gb.Get("/hello", func(ctx gearbox.Context) {
    var r Response
    ctx.SendJSON(&r)
})

Sets the HTTP status code of response

Status(status int) Context

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    ctx.Status(gearbox.StatusUnauthorized)
})

Returns the HTTP request header specified by field key

Get(key string) string

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    headerValue = ctx.Get("custom-header-request")
    // ...
})

Sets the response's HTTP header field key to the specified key, value

Set(key string, value string)

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    ctx.Set("custom-header-response", "my-value")
    // ...
})

Returns the query string parameter in the request url

Query(key string) string

Example

gb.Get("/book", func(ctx gearbox.Context) {
    name := ctx.Query("name")
    // ...
})

Returns the raw body (string) submitted in a POST request

Body() string

Example

gb.Get("/hello", func(ctx gearbox.Context) {
    requestBody := ctx.Body()
    // ...
})

Parses request body into provided struct. Currently, Supports decoding theses types: application/json.

ParseBody(out interface{}) error

Example

type Request struct {
    Value string
}

gb.Get("/hello", func(ctx gearbox.Context) {
    var req Request
    ctx.ParseBody(&req)

    // ...
})