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

お探しのものが見つかりませんでしたか？コミュニティに質問する
間違いを見つけましたか？お知らせください