Skip to content
ADP
API Design PrincipleBETA

[ADP-151] Content-Disposition

概述

Content-Disposition 標頭用於指定內容在瀏覽器中的顯示方式。它通常在 HTTP 回應中使用,以指示內容是否應在瀏覽器中內嵌顯示,或者應當作附件下載保存。

指導原則

  • 應(SHOULD)在二進位檔案或非文字類型的 MIME-Type 回應中包含 Content-Disposition 標頭,例如用於獲取圖片的 API。

    TIP

    如果您的 API 支持 CORS,請確保更新 Access-Control-Expose-Headers。有關更多資訊,請參考 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers。

  • 這個標頭可以有兩個主要的值:
    • inline:這個值表示內容應該直接在瀏覽器中顯示。
    • attachment:這個值表示內容應該下載並在本地保存。
  • DRAFT 對於不受直接控制的二進制文件,例如用戶上傳的圖像文件,建議避免將 Content-Disposition 設置為 inline,因為可能包含敏感內容所以不宜直接顯示在瀏覽器中。
    • 換句話說,建議(RECOMMENDED)將 Content-Disposition 設置為 attachment

示例

http
Content-Disposition: attachment; filename="example.pdf"

這個示例建議瀏覽器應該下載名為 example.pdf 的文件。

參考