OPTIONS 請求方法

Baseline 已廣泛支援

此特性已相當成熟,可在許多裝置和瀏覽器版本上使用。自 ⁨2015 年 7 月⁩以來,各瀏覽器均已提供此特性。

OPTIONS HTTP 方法請求給定 URL 或伺服器允許的通訊選項。這可用於測試請求允許的 HTTP 方法,或確定請求在進行 CORS 預檢請求時是否會成功。客戶端可以使用此方法指定 URL,或使用星號 (*) 指代整個伺服器。

請求有正文 可能*
成功響應有正文 可能
安全
冪等
可快取
允許在 HTML 表單中使用

* 儘管技術上允許帶有請求正文的 OPTIONS 訊息,但它沒有定義的語義。只要您提供有效的 Content-Type 標頭,並且您知道伺服器期望它,您就可以在 OPTIONS 訊息中包含正文,因為行為是實現特定的。

語法

http
OPTIONS *|<request-target>["?"<query>] HTTP/1.1

請求目標可以是“星號形式”* 表示整個伺服器,也可以是與其他方法常見的請求目標

*

表示客戶端希望為整個伺服器而不是該伺服器的特定命名資源請求 OPTIONS

<請求目標>

Host 標頭中提供的資訊結合使用時,標識請求的目標資源。這是對源伺服器的請求中的絕對路徑(例如,/path/to/file.html),以及對代理的請求中的絕對 URL(例如,http://www.example.com/path/to/file.html)。

<query> 可選

一個可選的查詢元件,前面帶有一個問號 ?。通常用於以 key=value 對的形式攜帶識別資訊。

示例

識別允許的請求方法

要找出伺服器支援哪些請求方法,可以使用 curl 命令列程式發出 OPTIONS 請求

bash
curl -X OPTIONS https://example.org -i

這將建立以下 HTTP 請求

http
OPTIONS / HTTP/2
Host: example.org
User-Agent: curl/8.7.1
Accept: */*

響應包含一個 Allow 標頭,其中包含允許的方法

http
HTTP/1.1 204 No Content
Allow: OPTIONS, GET, HEAD, POST
Cache-Control: max-age=604800
Date: Thu, 13 Oct 2016 11:45:00 GMT
Server: EOS (lax004/2813)

CORS 中的預檢請求

CORS 中,使用 OPTIONS 方法傳送預檢請求,以便伺服器可以響應是否可以傳送請求。在此示例中,我們將請求這些引數的許可權

http
OPTIONS /resources/post-here/ HTTP/1.1
Host: bar.example
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Connection: keep-alive
Origin: https://foo.example
Access-Control-Request-Method: POST
Access-Control-Request-Headers: content-type,x-pingother

伺服器現在可以響應是否在此類情況下接受請求。在此示例中,伺服器響應說

Access-Control-Allow-Origin

允許 https://foo.example 源透過以下方式請求 bar.example/resources/post-here/ URL

Access-Control-Allow-Methods

POSTGETOPTIONS 是該 URL 允許的方法。(此標頭類似於 Allow 響應標頭,但僅用於 CORS。)

Access-Control-Allow-Headers

X-PINGOTHERContent-Type 是該 URL 允許的請求標頭。

Access-Control-Max-Age

上述許可權可快取 86,400 秒(1 天)。

http
HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: https://foo.example
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: X-PINGOTHER, Content-Type
Access-Control-Max-Age: 86400
Vary: Accept-Encoding, Origin
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive

注意: 200 OK204 No Content 都是允許的狀態碼,但一些瀏覽器錯誤地認為 204 No Content 適用於資源,並且不會發送後續請求來獲取它。

規範

規範
HTTP 語義
# OPTIONS

瀏覽器相容性

另見