Real ドキュメント

構文

request(options: RequestOptions): Response | string

エイリアス http_requesthttp.request

引数

名前	型	説明
`options`	`RequestOptions`	操作の動作を制御するオプションの設定テーブル。

戻り値

名前	型	説明
`response`	`Response \| string`	HTTP 応答テーブルまたは互換性文字列。

説明

メソッド、ヘッダー、本文、タイムアウトオプションを指定して HTTP リクエストを送信します。

1 個のパラメータで呼び出します: options。引数表では必須値と動作を調整する値を確認できます。

response (Response | string) を返します。戻り値表を使って成功値、nil 結果、回復可能なエラーを分けて扱ってください。

例

JSON リクエストを送信し、パブリック応答フィールドを検査します。

local response = request({
    Url = "https://example.com/api/status",
    Method = "GET",
    Headers = {
        ["Accept"] = "application/json",
    },
})

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

型

RequestOptions

HTTPリクエストを定義します。

Url string HTTP または HTTPS の宛先 URL。Method? "GET" | "POST" | "PUT" | "PATCH" | "DELETE" リクエストに使用される HTTP メソッド。Headers? {[string]: string} 追加のリクエストヘッダー。Cookies? {[string]: string} 発信リクエストに Cookie が追加されました。Body? string 生のリクエスト本文。