Structure

HTTPRequest

HTTP load request.

Declaration

struct HTTPRequest

Overview

HTTPRequest is very similar to URLSession’s URLRequest. HTTPRequest represents an HTTP request.

Topics

Initialization

init(endpoint: URL)
Initializes a HTTPRequest object.
init(endpoint: URL, withBody: [String : Any], bodyEncoding: RequestBodyEncoding)
Initializes a HTTPRequest object, with a body.

Options

Options can be set for the request like this:

Discussion


httpRequestInstance.endpointQueryItems = ["key": "value"]
var httpMethod: HTTPMethod
The HTTPMethod of the request, default is GET.
var additionalHTTPHeaders: [String : String]?
Any additional HTTP header values besides “Authentication” and “Content-Type”.
var httpBody: [String : Any]?
The body of the HTTP request.
var bodyEncoding: RequestBodyEncoding
The RequestBodyEncoding of the body being sent. Defaults to RequestBodyEncoding.FORM.
var endpointQueryItems: [String : String]?
Query items to add to the endpoint URL.
var timeoutAfter: TimeAmount?
Set the amount of time allowed for the request to complete before it times out.

Initialized

let endpoint: URL
The server endpoint URL to which the HTTP request will be sent. Is initialized.

See Also

Request and Response

func authenticatedRequest(for: HTTPRequest, numberOfRetries: UInt8) async throws -> HTTPRequest.Response
Sends an authenticated HTTP request to a Web API endpoint. Returns a HTTPRequest.Response.
struct Response
The response from a authenticatedRequest(for:numberOfRetries:).