horse-request-response

Horse Request & Response

THorseRequest (Reading Request Data)

The THorseRequest object contains all details of the incoming HTTP request.

• Body: To read the raw text payload, use Req.Body. If the Jhonson middleware is active, you can read the parsed JSON directly:

  var
    LBody: TJSONObject;
  begin
    LBody := Req.Body<TJSONObject>;
  end;
  

• Params: For path parameters (defined with :name), use Req.Params.Items['name'] (or Req.Params['name']).
• Query: For query parameters (e.g., ?page=1&limit=10), use Req.Query.Items['page'] (or Req.Query['page']).
• Headers: Read request headers using Req.Headers.Items['Authorization'].

---

Safe Parameter Parsing & Validation (THorseCoreParamField)

Instead of accessing raw string dictionary values (e.g., Req.Params['id']) and converting them manually, always prefer using the .Field() method to obtain a THorseCoreParamField. This provides type-safe conversions and declarative parameter validation:

• Type Conversion: Convert parameters to the target type without manually calling StrToInt or StrToBool:

  var
    LId: Integer;
    LActive: Boolean;
    LDate: TDateTime;
  begin
    LId := Req.Params.Field('id').AsInteger;
    LActive := Req.Query.Field('active').AsBoolean;
    LDate := Req.Query.Field('since').AsISO8601DateTime;
  end;
  

• Required Check: Automatically halt execution and return a 400 Bad Request with a custom error message if the parameter is missing:

  var
    LEmail: string;
  begin
    // Automatically raises EHorseException if 'email' query param is empty
    LEmail := Req.Query.Field('email').Required.RequiredMessage('The "email" parameter is required.').AsString;
  end;
  

• Supported Converters: AsInteger, AsInt64, AsBoolean, AsFloat, AsCurrency, AsDateTime, AsISO8601DateTime, AsStream (for multipart uploads), and AsString.