Request

Vox’s Request object is built on top of go’s native net/http.Request.

Actually, a vox.Request is embedding a net/http.Request in its struct definition. So you can access any of net/http.Request’s public fields or methods from a vox.Request.

For example, you can access a request’s HTTP header like this:

func ExampleHandler(ctx *vox.Context, req *vox.Request, res *vox.Response) {
    fmt.Println("secret from request header: ", req.Header.Get("X-Secret"))
}

Additionally, vox.Request has some extra fields/methods that net/http.Request does not provide.

For example, vox has a JSON method to decode a JSON request body to go values, with additional functionality to check the content-type header from the request. If the content-type header does not start with “application/json” or a decode error occurs, this function will return an error and set the response status code to 406.

func PostJSONHandler(ctx *vox.Context, req *vox.Request, res *vox.Response) {
    body := map[string]string{}
    if err := req.JSON(&body); err != nil {
        return  // You do not need to set the response's status code, as vox has already set it.
    }
    // ...
}