Request & Response Objects

Request and Response objects are available to the controller as request and response methods.

The Request Object and Controller Helper Methods

It serves both to perform requests by an HTTP::Client and to represent requests received by an HTTP::Server. A request always holds an IO as a body. When creating a request with a String or Bytes its body will be a IO::Memory wrapping these, and the Content-Length header will be set appropriately.

The request object contains a lot of useful information about the request coming in from the client. To get a full list of the available methods, refer to the Crystal API Documentation https://crystal-lang.org/api/latest/HTTP/Request.html

Helper Methods

Purpose

Implemented?

host

The hostname used for this request.

Yes

domain(n=2)

The hostname's firstnsegments, starting from the right (the TLD).

No

format

The content type requested by the client.

Yes

method

The HTTP method used for the request.

Yes

get?, post?, patch?, put?, delete?, head?

Returns true if the HTTP method is GET/POST/PATCH/PUT/DELETE/HEAD.

Yes

headers

Returns a hash containing the headers associated with the request.

Yes

port

The port number (integer) used for the request.

Yes

protocol

Returns a string containing the protocol used plus "://", for example "http://".

No

query_string

The query string part of the URL, i.e., everything after "?".

Yes

client_ip

The IP address of the client via cookie headers.

Yes

requested_url

The entire URL used for the request.

No

The Response Object

The response object is not usually used directly, but is built up during the execution of the action and rendering of the data that is being sent back to the user, but sometimes - like in an after filter - it can be useful to access the response directly. Some of these accessor methods also have setters, allowing you to change their values. To get a full list of the available methods, refer to the https://crystal-lang.org/api/latest/HTTP/Server/Response.html

Properties

Purpose

body

This is the string of data being sent back to the client. This is most often HTML.

status

The HTTP status code for the response, like 200 for a successful request or 404 for file not found.

location

The URL the client is being redirected to, if any.

content_type

The content type of the response.

charset

The character set being used for the response. Default is "utf-8".

headers

Headers used for the response.