Документация Real

Синтаксис

request(options: RequestOptions): Response | string

Алиасы http_requesthttp.request

Аргументы

Имя	Тип	Описание
`options`	`RequestOptions`	Request options table. Url is required; Method, Headers, Cookies, and Body are optional.

Возвраты

Имя	Тип	Описание
`response`	`Response \| string`	On request error, an error string. Otherwise a response table.

Описание

Sends an HTTP or HTTPS request and yields until it completes. options must include Url. Method defaults to GET and must be GET, POST, PUT, PATCH, or DELETE. Headers, Cookies, and Body are optional. Request errors return an error string; completed requests return a response table.

Вызывай с 1 параметрами: options. Таблица аргументов показывает обязательные значения и настройки поведения.

Возвращает response (Response | string). Используй таблицу возвращаемых значений, чтобы отличать успех, nil и обрабатываемые ошибки.

Пример

Send a GET request and handle either the response table or the request error string.

local response = request({
    Url = "https://example.com/api/status",
    Method = "GET",
})

if type(response) == "table" then
    if response.Success then
        print(response.StatusCode, response.Body)
    else
        warn(response.StatusMessage)
    end
else
    warn(response)
end

Типы

RequestOptions

Определяет options table, которую читает request.

Url string Required HTTP or HTTPS URL. The value must start with http:// or https:// and must not match the blocked URL list.Method? "GET" | "POST" | "PUT" | "PATCH" | "DELETE" Optional method. Defaults to GET. Accepted values after ASCII lowercase normalization are GET, POST, PUT, PATCH, and DELETE.Headers? {[string]: string} Optional table of request headers. Keys and values are checked with Lua runtime and rejected if they contain CR or LF. Host, Connection, Content-Length, and Cookie are not forwarded directly.Cookies? {[string]: string} Optional table of cookies. Keys and values are checked with Lua runtime and rejected if they contain CR or LF, then merged into the outgoing Cookie header.Body? string Optional request body copied with string conversion. The body is only passed to HTTP request client when it is not empty.

Response

Определяет response table, которую request возвращает без request error.

Success boolean Boolean set to true when StatusCode is between 200 and 299 inclusive.StatusCode integer Integer HTTP status code from HTTP status code.Body string Response body string from HTTP response body.StatusMessage string Status reason string from HTTP status message.RawHeaders string Raw header text recondata structureed by the function from the status line, response headers, and Set-Cookie values.Headers {[string]: string} Table parsed from RawHeaders by splitting lines on the first colon. Later duplicate names overwrite earlier values.Cookies {[string]: string} Table parsed from Set-Cookie lines.ROBLOSECURITY is skipped.