request - Real Function Reference

request(options: RequestOptions): Response | string

별칭

http_request
http.request

인수

RequestOptions

필수

Request options table. Url is required; Method, Headers, Cookies, and Body are optional.

반환값

Response | string

On request error, an error string. Otherwise a response table.

타입

RequestOptions

request가 읽는 options table을 정의합니다.

Name	Type	Required	설명
`Url`	`string`	Yes	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"`	No	Optional method. Defaults to GET. Accepted values after ASCII lowercase normalization are GET, POST, PUT, PATCH, and DELETE.
`Headers`	`{[string]: string}`	No	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}`	No	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`	No	Optional request body copied with string conversion. The body is only passed to HTTP request client when it is not empty.

Response

request error가 없을 때 request가 반환하는 response table을 정의합니다.

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

예제

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

​Response

​예제

별칭

인수

반환값

타입

RequestOptions

Response

예제