Reply Builder

aah provides powerful Reply builder (aka Response Builder) to compose your response effectively. Chained call supported.

Table of Contents

Response Status Codes

As per RFC7231, Reply() provides method for frequently used ones.

  • Ok()
  • Created()
  • Accepted()
  • NoContent()
  • MovedPermanently()
  • Found()
  • TemporaryRedirect()
  • BadRequest()
  • Unauthorized()
  • Forbidden()
  • NotFound()
  • MethodNotAllowed()
  • NotAcceptable()
  • Conflict()
  • UnsupportedMediaType()
  • InternalServerError()
  • ServiceUnavailable()

ohh, the response status I need is not in the above list, no problem; use Reply().Status(http.StatusPartialContent) or Reply().Status(206)

Response Content

Rich reply methods for the response.

  • HTML(data)
  • HTMLl(layout, data)
  • HTMLf(filename, data)
  • HTMLlf(layout, filename, data)
  • JSON(data)
  • JSONP(data, callback)
  • JSONSecure(data)
  • XML(data)
  • Text(str)
  • Text(str, args)
  • FromReader(reader)
  • File(file)
  • FileDownload(file, targetName) - Content-Disposition is attachment
  • FileInline(file, targetName) - Content-Disposition is inline
  • Binary(bytes)
  • Error(err) - know more.
  • Render(rdr) - custom rendering implementation know more

Redirect

  • Redirect(url)
  • RedirectWithStatus(url, statusCode)

Replying HTTP Headers

  • Header(hdr, value)
  • HeaderAppend(hdr, value)

Cookies

  • Cookie(cookie)

Disable Gzip

By default aah doesn’t apply Gzip compression for Status Codes 204, 304 and if client doesn’t support gzip. On top of it aah provides method DisableGzip as an option to disable gzip compression for a particular response.

Reply().DisableGzip()

Done()

Done method indicates that reply has already been sent via ctx.Res and that no further action is needed.

Note: aah doesn't intervene with response if `Done()` method was called.

Custom Rendering

aah provides reply method called Render to supply your own implementation of rendering.

  • You could do by implementing interface aah.Render
  • Or using adaptor func aah.RenderFunc

Example of implementing interface aah.Render

// CustomRender implements the interface `aah.Render`.
type CustomRender struct {
	// ... your fields goes here
}

func (cr *CustomRender) Render(w io.Writer) error {
  // implementation goes here
  // return error for any issues
  return nil
}

// Then you call render method in your controller action
Reply().Render(&CustomRender{
  // fields goes here
})

Example of adaptor aah.RenderFunc

Reply().Render(aah.RenderFunc(func(w io.Writer) error {
  // implementation goes here
  // return error for any issues
  return nil
}))

Few Samples

Refer to Response Status Codes and Response Content to know more.

// Replying JSON with Status Code 200 OK
Reply().Ok().JSON(data)

// Default Status Code is 200 OK, so you can do
Reply().JSON(data)

// Replying JSON with Status Code 400 BAD REQUEST
Reply().BadRequest().JSON(data)

// Replying file as an attachment from absolute path
// Default Status Code is 200 OK
Reply().FileDownload("/User/jeeva/songs/nice.mp3", "name-nice.mp3")

// I just want serve file from controller.
// Path could absolute or relative path.
// if its relative aah resolve the path app base directory
// For e.g.: <app-base-dir>/assets/reports/daily.pdf
Reply().File("assets/reports/daily.pdf")
Reply().File("/mnt/may/reports/daily.pdf")

// I would like to send binary data
Reply().Binary(bytes)

// I would like to use Reader
Reply().FromReader(reader)

// Replying redirect login page using `route name`
Reply().Redirect(c.RouteURL("user_login"))

// Replying HTML response with cookie and view arguments
Reply().
  Cookie(&http.Cookie{
    //....
  }).
  HTML(data)

// Replying HTML response with custom layout and data
Reply().HTMLl("master-custom.html", data)

// Replying Error - processed by Centralized Error Handler before writing a reply
Reply().Error({
  Code: http.StatusNotFound,
  Message: "Resource not found",
  Data: "relevant data if you would like to add for error handler", // this is type interface{}.
})