MIME 類型

API 可以接受和傳回不同格式的資料，最常見的是 JSON 和 XML。您可以使用 consumes 和 produces 關鍵字來指定您的 API 可以理解的 MIME 類型。consumes 和 produces 的值是 MIME 類型的陣列。全域 MIME 類型可以在 API 規格的根層級定義，並由所有 API 操作繼承。此處 API 使用 JSON 和 XML

1
consumes:
2
  - application/json
3
  - application/xml
4
produces:
5
  - application/json
6
  - application/xml

請注意，consumes 只會影響具有請求主體的操作，例如 POST、PUT 和 PATCH。它會被無主體的操作（例如 GET）忽略。在操作層級使用時，consumes 和 produces 會覆寫（而不是擴充）全域定義。在以下範例中，GET /logo 操作會重新定義 produces 陣列以傳回影像

1
paths:
2
  /logo:
3
    get:
4
      summary: Returns the logo image
5
      produces:
6
        - image/png
7
        - image/gif
8
        - image/jpeg
9
      responses:
10
        200:
11
          description: OK
12
          schema:
13
            type: file

consumes 和 produces 中列出的 MIME 類型應符合 RFC 6838。例如，您可以使用標準 MIME 類型，例如

1
application/json
2
application/xml
3
application/x-www-form-urlencoded
4
multipart/form-data
5
text/plain; charset=utf-8
6
text/html
7
application/pdf
8
image/png

以及廠商特定的 MIME 類型（以 vnd. 表示）

1
application/vnd.mycompany.myapp.v2+json
2
application/vnd.ms-excel
3
application/vnd.openstreetmap.data+xml
4
application/vnd.github-issue.text+json
5
application/vnd.github.v3.diff
6
image/vnd.djvu

找不到您要找的內容嗎？向社群提問
發現錯誤？告訴我們