response

Okapi Response Helpers

For aborts, error handlers, and RFC 7807 Problem Details, see the error_handling/ skill.

JSON Responses

c.OK(data)            // 200
c.Created(data)       // 201
c.NoContent()         // 204, empty body
c.JSON(code, data)    // custom status

Other Formats

c.XML(code, data)
c.YAML(code, data)
c.Text(code, data) / c.String(code, data)   // String is an alias for Text
c.Data(code, contentType, []byte)           // raw bytes with an explicit content type
c.HTML(code, file, data)                    // parse and render a template file
c.HTMLView(code, templateStr, data)         // render an inline template string
c.Render(code, name, data)                  // named template via the configured Renderer
c.Redirect(code, location)                  // writes the redirect; returns nothing

c.Redirect has no return value — write c.Redirect(...); return nil.

File Serving

c.ServeFile(path)
c.ServeFileFromFS(filepath, fs)         // from any http.FileSystem
c.ServeFileAttachment(path, filename)   // Content-Disposition: attachment (download)
c.ServeFileInline(path, filename)       // Content-Disposition: inline

Structured Response (Body / Status / Header Pattern)

c.Respond (alias c.Return) introspects a struct and writes status, headers, cookies, and body from its fields.

type BookResponse struct {
    Status    int    // HTTP status code (defaults to 200 when absent/zero)
    Body      Book   // response payload
    RequestID string `header:"X-Request-ID"` // response header
    Session   string `cookie:"session"`      // response cookie (Path=/)
}

return c.Respond(&BookResponse{Status: 201, Body: book, RequestID: rid})

Field rules:

Field	Becomes
Status (int)	HTTP status code
Body	Response payload
tagged header:"X-Name"	Response header
tagged cookie:"name"	Set-Cookie with Path=/
anything else	A response header named after the field (or its json tag name)