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

request が読み取る options table を定義します。

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

request error がない場合に request が返す response table を定義します。

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.