Media type: MIME types — HTTP | MDN — Вебджем.рф | Создание и продвижение сайтов

MIME types — HTTP | MDN

Медиа тип (так же известный как Multipurpose Internet Mail Extensions или MIME тип) является стандартом, который описывает природу и формат документа, файла или набора байтов. Он определён и стандартизирован в спецификации RFC 6838 .

Организация Internet Assigned Numbers Authority (IANA) является ответственной за все официально признанные MIME типы, и вы можете найти самый последний и полный лист MIME типов на их странице Медиа Типов.

Предупреждение: Важно: Для принятия решения о том, как обрабатывать URL, браузеры используют MIME типы, а не расширения файлов, так что серверам необходимо отправлять правильные MIME типы в Content-Type заголовке ответа. При неточном задавании этого заголовка, браузеры с большой вероятностью будут неправильно интерпретировать и обрабатывать содержание файлов, из-за чего сайт будет работать неверно.

Простейший MIME тип состоит из

типа и подтипа — двух строк разделённых наклонной чертой (/), без использования пробелов.

тип/подтип

Тип представляет общую категорию, в которой находится тип данных, например video или text. Подтип же строго отождествляется с отдельным типом данных, представляемых данным MIME типом. Например, для MIME типа text, подтипы могут быть plain (простой текст), html (HTML source code) или calendar (для iCalendar .ics).

Необязательный параметр может быть добавлен для указания дополнительных деталей

тип/подтип;параметр=значение

Например, для MIME типов категории text, необязательный параметр charset может быть задан для уточнения кодировки, используемой в документе. Для объявления, что пересылаемый файл имеет кодировку UTF-8, необходимо использовать MIME тип

text/plain;charset=UTF-8. При не указании параметра charset, его значение автоматически будет задано, как ASCII (US-ASCII), если в настройках браузера не будет определено иначе.

MIME типы являются нечувствительными к регистру, но традиционно их пишут строчными буквами, за исключением значений параметров.

Типы

Все типы можно разделить на два класса: дискретные и многокомпонентные. Дискретные типы представляют одиночные файлы, например, одиночный текстовый, музыкальный или видео файл. Многокомпонентные типы представляют документы, составленные из нескольких частей, каждая из которых может иметь свой отдельный MIME тип, или они могут заключать в себе несколько отдельных файлов, передаваемых в одном сообщении. Например, многокомпонентные MIME типы используются для передачи нескольких изображений в одном email.

Дискретные типы

В настоящее время на IANA зарегистрированы следующие дискретные типы:

application Список IANA

Любой вид бинарных данных, явно не попадающих ни в одну другу группу типов. Данные, которые будут выполняться или как-либо интерпретироваться, или данные для выполнения, которых необходимо отдельное приложение. Для указания базового типа бинарных данных (данных без определённого типа) используют тип

application/octet-stream. Другие распространённые примеры включают application/pdf, application/pkcs8 и application/zip.

audio Список IANA

Аудио или музыкальные данные. Примеры: audio/mpeg, audio/vorbis.

example

Тип, зарезервированный для написания примеров, отображающих использование MIME типов. Этот тип никогда не должен использоваться вне примеров кода или документации. example может так же использоваться, как подтип.

font Список IANA

Данные шрифтов. Распространённые примеры включают font/woff, font/ttf и font/otf.

image Список IANA

Изображения или графические данные, включая векторную и растровую графику, а так же анимированные версии форматов неподвижных изображений, таких как GIF

(en-US) или APNG.

Распространённые примеры включают image/jpeg, image/png, и image/svg+xml.

model Список IANA

Данные моделей для 3D объектов или сцен. Примеры: model/3mf и model/vml.

text Список IANA

Любые текстовые данные, так или иначе доступные для чтения человеку, а так же исходный код или текстовые данные для программ. Примеры: text/plain, text/csv и text/html.

video Список IANA

Видео данные или файлы. Например, MP4 фильмы (video/mp4).

Любые текстовые документы без определённого подтипа стоит отправлять, как

text/plain тип. Аналогичным образом, application/octet-stream тип подойдёт бинарным документам при неопределённом или неизвестном подтипе.

Многокомпонентные типы

Многокомпонентные типы описывают категории разграниченных на части документов, где каждая из частей может иметь свой отдельный MIME тип. При работе с электронными письмами, они могут использоваться для описания нескольких отдельных файлов, передаваемых в одном сообщении. Они представляют составные документы.

За исключением multipart/form-data типа, используемого в POST методе HTML форм, и multipart/byteranges типа, используемом в ответе 206 Partial Content для отправки части документа, HTTP никаким особым образом не обрабатывает многокомпонентные типы, и просто отправляет данные в браузер (который, с большой вероятностью, предложит сохранить переданный файл, тоже не зная как его обработать).

Существуют два многокомпонентных типа:

message Список IANA: Сообщение, включающее в себя другие сообщения. Этот тип может использоваться, например, для представления сообщения, которое включают в себя другое переадресованное сообщение, как часть данных, или для отправки больших сообщений по частям, как если бы каждое сообщение отправлялось отдельно. Примеры включают message/rfc822 (для переадресованных или цитируемых сообщений) и message/partial для автоматического разделения одного большого сообщения на несколько небольших и их последующей сборки на стороне получателя.
multipart Список IANA: Данные составленные из нескольких компонентов, каждый из которых может иметь отдельный MIME тип. Примеры включают multipart/form-data (для данных созданных с помощью FormData API) и multipart/byteranges (определённого в RFC 7233: 5.4.1 и используемого в ответах HTTP 206 «Partial Content», когда запрашиваемые данные возвращаются по частям в нескольких сообщениях, как например, при использовании заголовка Range).

application/octet-stream

Этот тип является базовым для бинарных данных. В связи с тем, что он подразумевает неопределённые бинарные данные, браузеры, как правило, не будут пытаться его обработать каком-либо образом, а вызовут для него диалоговое окно «Сохранить Как», как если бы заголовок ответа Content-Disposition имел значение attachment.

text/plain

Этот тип является базовым для текстовых файлов. Несмотря на то, что он означает «неопределённые текстовые данные», браузеры всё равно могут его отображать.

Примечание: text/plain не означает «любой вид текстовых данных». Если браузер ожидает получения какого-то конкретного типа текстовых данных, то с большой вероятностью он не будет считать text/plain подходящим типом. Например, при загрузке text/plain документа через <link> элемент, браузер не будет его признавать правильным CSS файлом и использовать для применения стилей. Только text/css тип должен использоваться для загрузки CSS документов.

text/css

CSS документы, используемые для стилизации web-страниц должны отправляться, как text/css тип. Большинство браузеров не смогут распознавать CSS документы, загруженные с отличным от text/css MIME типом.

text/html

Все HTML данные должны пересылаться с данным типом. Альтернативные MIME типы для XHTML (например, application/xhtml+xml) почти не используются в настоящее время.

Примечание: Используйте application/xml или application/xhtml+xml, когда вам необходим строгий синтаксический анализ документов, разделы <![CDATA[…]]> или элементы, не принадлежащие к пространствам имён HTML/SVG/MathML.

text/javascript

Согласно HTML спецификации: при пересылке JavaScript файлов, всегда должен использоваться MIME тип text/javascript.

По исторически сложившимся причинам, MIME Sniffing Standard (стандарт, определяющий, как браузеры должны интерпретировать медиа типы и выяснять, как обрабатывать данные при неправильно заданных медиа типах) позволяет серверам отправлять JavaScript документы, используя один из нижеперечисленных типов:

application/javascript
application/ecmascript
application/x-ecmascript Check cross-browser support before using.»> Non-standard
application/x-javascript Non-standard
text/javascript
text/ecmascript
text/javascript1.0 Non-standard
text/javascript1.1 Non-standard
text/javascript1.2 Non-standard
text/javascript1.3 Non-standard
text/javascript1.4 Non-standard
text/javascript1. 5 Non-standard
text/jscript Non-standard
text/livescript Non-standard
text/x-ecmascript Non-standard
text/x-javascript Non-standard

Примечание: Несмотря на то, что некоторые user agent могут поддерживать какие-то из вышеперечисленных типов, вы всегда должны использовать text/javascript. Это единственный MIME тип, который гарантированно будет работать в настоящее время и в будущем.

Иногда вы можете заметить использование text/javascript MIME типа в связке с параметром charset, для уточнения кодировки, в которой был написан файл. Такое определение MIME типа является неправильным, и в большинстве случаев браузеры не станут загружать скрипт, передаваемый с таким типом.

Типы изображений

Файлы, MIME типом которых является image, содержат в себе данные изображений. Подтип определяет, какой конкретный формат изображения представлен в данных.

Лишь несколько типов изображений достаточно распространены, чтобы безопасно использоваться на веб-страницах.

{{page(«ru/docs/Web/Media/Formats/Image_types», «table-of-image-file-types»)}}

Аудио и видео типы

Так же как в случае с изображениями, стандарт HTML не обязывает браузеры поддерживать какие-либо определённые форматы и кодеки для <audio> и <video> элементов, так что при их выборе, важно брать в расчёт целевую аудиторию и диапазон браузеров (а так же версии этих браузеров), которые она может использовать.

Наше руководство по медиа форматам (en-US) предоставляет список общепринятых типов, включая информацию об особых случаях при их использовании, их недостатках, совместимости, а так же других деталях.

Руководства по аудио (en-US) и видео (en-US) кодекам перечисляют часто поддерживаемые браузерами кодеки, предоставляя детали по их совместимости и техническую информацию, например как много аудио каналов они поддерживают, какой тип сжатия используют, и так далее. Руководство по используемым в WebRTC кодекам развивает эту тему ещё дальше, конкретно описывая кодеки, поддерживаемые популярными браузерами, так чтобы вы могли выбрать кодеки, которые имеют наилучшую поддержку в диапазоне браузеров по вашему выбору.

Что касается MIME типов для аудио и видео файлов, то чаще всего они указывают на формат контейнера (тип файла). Необязательный параметр codecs может быть добавлен к MIME типу для более точного указания, какой кодек и параметры использовались для пересылаемого файла.

Ниже перечислены наиболее часто используемые на веб-страницах MIME типы. Обратите внимание, что это не полный перечень всех доступных типов. Более полный список поддерживаемых форматов может быть найден в руководстве по медиа форматам (en-US).

MIME тип	Аудио или видео тип
`audio/wave` `audio/wav` `audio/x-wav` `audio/x-pn-wav`	Аудио файл WAVE формата. С PCM аудио кодеком (WAVE кодек «1»), считающимся наиболее поддерживаемым, а так же другими, имеющими ограниченную поддержку.
`audio/webm`	Аудио файл формата WebM. С Vorbis и Opus официально поддерживаемыми WebM спецификацией аудио кодеками.
`video/webm`	Видео файл, с возможной аудио дорожкой, формата WebM. С VP8 и VP9, как наиболее распространёнными видео кодеками; Vorbis и Opus, как наиболее распространёнными аудио кодеками.
`audio/ogg`	Аудио файл формата OGG. С Vorbis, как наиболее распространённым аудио кодеком. Хотя на данный момент имеется поддержка и Opus кодека.
`video/ogg`	Видео файл, с возможной аудио дорожкой, в формате OGG. Где Theora – наиболее часто встречающийся видео кодек и Vorbis — наиболее часто встречающийся аудио кодек. Хотя использование кодека Opus становится всё более распространённым.
`application/ogg`	Аудио или видео формата OGG. Где Theora – наиболее часто встречающийся видео кодек и Vorbis — наиболее часто встречающийся аудио кодек.

multipart/form-data

multipart/form-data тип может быть использован при отправке значений из заполненной HTML Формы на сервер.

Как многокомпонентный тип документа, он состоит из различных частей, разделённых специальной границей (строкой, начинающейся с двух чёрточек --), где каждая часть представляет собой отдельную сущность и имеет отдельные HTTP заголовки Content-Disposition и Content-Type для загружаемых файлов.

Content-Type: multipart/form-data; boundary=aBoundaryString
(other headers associated with the multipart document as a whole)
--aBoundaryString
Content-Disposition: form-data; name="myFile"; filename="img. jpg"
Content-Type: image/jpeg
(data)
--aBoundaryString
Content-Disposition: form-data; name="myField"
(data)
--aBoundaryString
(more subparts)
--aBoundaryString--

Следующая форма <form>:

<form action="http://localhost:8000/" method="post" enctype="multipart/form-data">
  <label>Name: <input name="myTextField" value="Test"></label>
  <label><input type="checkbox" name="myCheckBox"> Check</label>
  <label>Upload file: <input type="file" name="myFile" value="test.txt"></label>
  <button>Send the file</button>
</form>

отправит сообщение:

POST / HTTP/1.1
Host: localhost:8000
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:50.0) Gecko/20100101 Firefox/50.0
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
Upgrade-Insecure-Requests: 1
Content-Type: multipart/form-data; boundary=---------------------------8721656041911415653955004498
Content-Length: 465
-----------------------------8721656041911415653955004498
Content-Disposition: form-data; name="myTextField"
Test
-----------------------------8721656041911415653955004498
Content-Disposition: form-data; name="myCheckBox"
on
-----------------------------8721656041911415653955004498
Content-Disposition: form-data; name="myFile"; filename="test. txt"
Content-Type: text/plain
Simple file.
-----------------------------8721656041911415653955004498--

multipart/byteranges

multipart/byteranges MIME тип используется для отправки данных в браузер по частям.

При отправке кода состояния 206 Partial Content, этот MIME тип будет означать, что документ состоит из нескольких частей, по одной для каждого отдельно запрашиваемого диапазона. Аналогично с остальными многокомпонентными типами, заголовок Content-Type используется для объявления границы boundary, разделяющей документ на отдельные компоненты. Каждый компонент имеет заголовок Content-Type, описывающий тип сегмента данных, и Content-Range (en-US), описывающий его диапазон.

HTTP/1.1 206 Partial Content
Accept-Ranges: bytes
Content-Type: multipart/byteranges; boundary=3d6b6a416f9b5
Content-Length: 385
--3d6b6a416f9b5
Content-Type: text/html
Content-Range: bytes 100-200/1270
eta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <meta name="vieport" content
--3d6b6a416f9b5
Content-Type: text/html
Content-Range: bytes 300-400/1270
-color: #f0f0f2;
        margin: 0;
        padding: 0;
        font-family: "Open Sans", "Helvetica
--3d6b6a416f9b5--

Большинство серверов отправляет ресурсы неопределённого типа, как application/octet-stream MIME тип. Большинство же браузеров, в целях безопасности, не позволяет их никак обрабатывать, вынуждая пользователя сохранять их на жёсткий диск, для дальнейшего использования.

Несколько советов по правильной настройке MIME типов на серверах:

RAR-сжатые файлы. В этом случае самым правильным вариантом было бы задать тип изначального ресурса; но это не всегда выполнимо, так как .RAR файлы могут хранить в себе несколько типов данных. Тогда, настройте сервер на отправку application/x-rar-compressed MIME типа вместе с RAR ресурсами.
Аудио и видео. Только ресурсы с правильно заданными MIME типами могут производиться в <video> и <audio> элементах. Убедитесь, что вы используете правильные типы для аудио и видео данных (en-US).
Запатентованные типы файлов. Избегайте использования application/octet-stream при их отправке, так как большинство браузеров не позволит определять способы обработки (например, «Открыть в Word») для этого базового MIME типа. Используйте специальные типы, например application/vnd.mspowerpoint, чтобы позволить пользователям открывать загруженный ресурс в программе по их выбору.

В отсутствии заданного MIME типа, или в определённых случаях, когда браузеры полагают, что MIME тип задан неправильно, они могут выполнять MIME sniffing — попытку угадать правильный MIME тип, анализируя характеристики ресурса.

Каждый браузер выполняет MIME sniffing по-своему и при разных условиях (например, Safari будет смотреть на расширение файла, если переданный MIME тип является неподходящим для документа). В этих случаях могут присутствовать опасения по поводу безопасности, так как некоторые MIME типы представляют исполняемые файлы. Сервера имеют возможность предотвращать MIME sniffing, отправляя X-Content-Type-Options заголовок ответа.

MIME типы не являются единственным способом сообщения типа документа:

Суффиксы в названиях файлов могут указывать на тип документа, главным образом на Microsoft Windows. Но не все операционные системы могут считать их имеющими смысл (например, Linux или MacOS). А так же нет никакой гарантии, что они будут указывать на правильный тип.
Магические числа. Синтаксисы различных форматов позволяют узнавать их тип, через анализ их структуры байтов. Например, GIF файлы начинаются с 47 49 46 38 39 шестнадцатеричного значения (GIF89), а PNG файлы с 89 50 4E 47 (.PNG). Опять же, не все типы документов имеют магические числа, так что этот подход так же не надёжен на 100%.

Медиа технологии в web
Руководство по медиа типам и форматам в web
Настраивание MIME типов на стороне сервера (en-US)

Found a content problem with this page?

Edit the page on GitHub.
Report the content issue.
View the source on GitHub.

Want to get more involved?

Learn how to contribute.

This page was last modified on 11 февр. 2023 г. by MDN contributors.

Общие типы MIME — HTTP

В этом разделе перечислены наиболее распространенные типы MIME с соответствующими типами документов, упорядоченные по их общим расширениям.

Следующие два важных типа MIME являются типами по умолчанию:

text/plain — значение по умолчанию для текстовых файлов. Текстовый файл должен быть удобочитаемым и не должен содержать двоичных данных.
application/octet-stream — значение по умолчанию для всех остальных случаев. Неизвестный тип файла должен использовать этот тип. Браузеры проявляют особую осторожность при манипулировании этими файлами, чтобы защитить пользователей от уязвимостей программного обеспечения и возможного опасного поведения.

IANA является официальным реестром типов носителей MIME и ведет список всех официальных типов MIME. В этой таблице перечислены важные типы MIME для Интернета:

Extension	Вид документа	Тип MIME
`. aac`	Аудио AAC	`аудио/акустика`
`.abw`	Документ AbiWord	`приложение/x-abiword`
`.arc`	Архивный документ (несколько встроенных файлов)	`приложение/x-freearc`
`.avif`	Изображение AVIF	`изображение/авиафайл`
`.avi`	AVI: Чередование аудио-видео	`видео/x-msvideo`
`.azw`	Формат электронной книги Amazon Kindle	`приложение/vnd.amazon.ebook`
`.bin`	Любые двоичные данные	`приложение/октетный поток`
`. bmp`	Растровая графика Windows OS/2	`изображение/bmp`
`.bz`	BZip-архив	`приложение/x-bzip`
`.bz2`	Архив BZip2	`приложение/x-bzip2`
`.cda`	Аудио компакт-диск	`приложение/x-cdf`
`.csh`	Сценарий C-Shell	`приложение/x-csh`
`.css`	Каскадные таблицы стилей (CSS)	`текст/CSS`
`.csv`	Значения, разделенные запятыми (CSV)	`текст/csv`
`.doc`	Microsoft Word	`приложение/msword`
`. docx`	Microsoft Word (OpenXML)	`приложение/vnd.openxmlformats-officedocument.wordprocessingml.document`
`.eot`	Встроенные шрифты MS OpenType	`приложение/vnd.ms-fontobject`
`.epub`	Электронная публикация (EPUB)	`приложение/epub+zip`
`.gz`	Сжатый архив GZip	`приложение/gzip`
`.gif`	Формат обмена графикой (GIF)	`изображение/gif`
`.htm` , `.html`	Язык гипертекстовой разметки (HTML)	`текст/html`
`.ico`	Формат значка	`изображение/vnd. microsoft.icon`
`.ics`	Формат iCalendar	`текст/календарь`
`.банка`	Архив Java (JAR)	`приложение/java-архив`
`.jpeg` , `.jpg`	изображений JPEG	`изображение/jpeg`
`.js`	JavaScript	`текст/javascript` (спецификации: HTML и RFC 9239)
`.json`	Формат JSON	`приложение/json`
`.jsonld`	Формат JSON-LD	`приложение/ld+json`
`.мид` , `.миди`	Цифровой интерфейс музыкальных инструментов (MIDI)	`аудио/миди` , `аудио/x-миди`
`. mjs`	Модуль JavaScript	`текст/javascript`
`.mp3`	MP3-аудио	`аудио/mpeg`
`.mp4`	Видео MP4	`видео/mp4`
`.mpeg`	Видео MPEG	`видео/mpeg`
`.mpkg`	Пакет установщика Apple	`приложение/vnd.apple.installer+xml`
`.odp`	Документ презентации OpenDocument	`приложение/vnd.oasis.opendocument.presentation`
`.ods`	Табличный документ OpenDocument	`приложение/vnd.oasis.opendocument.spreadsheet`
`. odt`	Текстовый документ OpenDocument	`приложение/vnd.oasis.opendocument.text`
`.ога`	Аудио OGG	`аудио/огг`
`.ogv`	Видео ОГГ	`видео/огг`
`.ogx`	ОГГ	`приложение/огг`
`.опус`	Опус аудио	`аудио/опус`
`.otf`	Шрифт OpenType	`шрифт/otf`
`.png`	Портативная сетевая графика	`изображение/png`
`.pdf`	Adobe Portable Document Format (PDF)	`приложение/pdf`
`. php`	Препроцессор гипертекста ( Персональная домашняя страница )	`приложение/x-httpd-php`
`.ppt`	Microsoft PowerPoint	`приложение/vnd.ms-powerpoint`
`.pptx`	Microsoft PowerPoint (OpenXML)	`приложение/vnd.openxmlformats-officedocument.presentationml.presentation`
`.rar`	Архив RAR	`приложение/vnd.rar`
`.rtf`	Расширенный текстовый формат (RTF)	`приложение/rtf`
`.ш`	Сценарий оболочки Борна	`приложение/х-ш`
`.svg`	Масштабируемая векторная графика (SVG)	`изображение/svg+xml`
`. tar`	Ленточный архив (TAR)	`приложение/x-tar`
`.tif` , `.tiff`	Формат файла изображения с тегами (TIFF)	`изображение/TIFF`
`.тс`	Транспортный поток MPEG	`видео/mp2t`
`.ttf`	Шрифт TrueType	`шрифт/ttf`
`.txt`	Текст (обычно ASCII или ISO 8859- n )	`текстовый/обычный`
`.vsd`	Microsoft Visio	`приложение/vnd.visio`
`.wav`	Аудиоформат сигнала	`аудио/wav`
`.веба`	аудио WEBM	`аудио/вебм`
`. вебм`	Видео WEBM	`видео/веб-сайт`
`.webp`	Изображение WEBP	`изображение/веб-страница`
`.woff`	Формат открытого веб-шрифта (WOFF)	`шрифт/woff`
`.woff2`	Формат открытого веб-шрифта (WOFF)	`шрифт/woff2`
`.xhtml`	XHTML	`приложение/xhtml+xml`
`.xls`	Microsoft Excel	`приложение/vnd.ms-excel`
`.xlsx`	Microsoft Excel (OpenXML)	`приложение/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
`. xml`	XML	`application/xml` рекомендуется согласно RFC 7303 (раздел 4.1), но `text/xml` все еще иногда используется. Вы можете назначить определенный тип MIME файлу с расширением `.xml` в зависимости от того, как его содержимое должно интерпретироваться. Например, фид Atom — это `application/atom+xml` , но `application/xml` служит допустимым значением по умолчанию.
`.xul`	СУЛ	`приложение/vnd.mozilla.xul+xml`
`.zip`	ZIP-архив	`приложение/zip`
`.3gp`	Контейнер аудио/видео 3GPP	`видео/3gpp` ; `аудио/3gpp` если не содержит видео
`.3g2`	Контейнер аудио/видео 3GPP2	`видео/3gpp2` ; `аудио/3gpp2` если не содержит видео
`. 7z`	7-zip архив	`приложение/x-7z-сжатый`

Обнаружили проблему с содержанием этой страницы?

Отредактируйте страницу на GitHub.
Сообщить о проблеме с содержимым.
Посмотреть исходный код на GitHub.

Хотите принять более активное участие?

Узнайте, как внести свой вклад.

Последний раз эта страница была изменена 3 марта 2023 г. участниками MDN.

Типы носителей

OAS 3 Эта страница посвящена OpenAPI 3.0. Если вы используете OpenAPI 2.0, см. руководство по OpenAPI 2.0.

Тип носителя — это формат данных тела запроса или ответа. Операции веб-службы могут принимать и возвращать данные в различных форматах, наиболее распространенными из которых являются JSON, XML и изображения. Вы указываете тип носителя в определениях запроса и ответа. Вот пример определения ответа:

  путей:
  /сотрудники:
    получать:
      резюме: возвращает список сотрудников.
      ответы:
        '200': # Ответ
          описание: хорошо
          content: # Тело ответа
            application/json: # Тип носителя
              схема: # Обязательно
                тип: объект # Тип данных
                характеристики:
                  идентификатор:
                    тип: целое число
                  имя:
                    тип: строка
                  на постоянной основе:
                    тип: логический
                пример: # Пример данных
                    идентификатор: 1
                    Имя: Джессика Райт
                    полное время: правда

В разделе ответов у нас есть определения индивидуальных ответов. Как видите, каждый ответ определяется своим кодом ( '200' в нашем примере). Ключевое слово , содержимое под кодом, соответствует тексту ответа. Один или несколько типов мультимедиа являются дочерними ключевыми словами этого ключевого слова контента . Каждый тип носителя включает в себя схему , определяющую тип данных тела сообщения и, необязательно, один или несколько примеров. Дополнительные сведения об определении данных тела см. в разделах Определение тела запроса и Определение ответов.

Имена типов носителей

Типы носителей, перечисленные под полем содержимого , должны соответствовать RFC 6838. Например, вы можете использовать стандартные типы или типы, зависящие от поставщика (обозначаются .vnd ) —

  приложение/json
приложение/xml
приложение/x-www-форма-urlencoded
multipart/form-data
текстовый/обычный; кодировка = utf-8
текст/html
приложение/pdf
изображение/png

  приложение/vnd.mycompany.myapp.v2+json
приложение /vnd.ms-excel
приложение/vnd.openstreetmap.data+xml
приложение/vnd.github-issue.text+json
приложение /vnd. github.v3.diff
изображение/vnd.djvu

Несколько типов носителей

Вы можете указать несколько типов носителей:

  путей:
  /сотрудники:
    получать:
      резюме: возвращает список сотрудников.
      ответы:
        '200': # Ответ
          описание: хорошо
          content: # Тело ответа
            application/json: # Один из типов мультимедиа
              схема:
                тип: объект
                характеристики:
                  идентификатор:
                    тип: целое число
                  имя:
                    тип: строка
                  на постоянной основе:
                    тип: логический
            application/xml: # Другие типы мультимедиа
              схема:
                тип: объект
                характеристики:
                  идентификатор:
                    тип: целое число
                  имя:
                    тип: строка
                  на постоянной основе:
                    тип: логический

Чтобы использовать один и тот же формат данных для нескольких типов носителей, определите пользовательский объект в разделе компонентов спецификации, а затем обратитесь к этому объекту в каждом типе носителей:

  путей:
  /сотрудники:
    получать:
      ответы:
        '200': # Ответ
          описание: хорошо
          content: # Тело ответа
            application/json: # Тип носителя
             схема:
               $ref: '#/components/schemas/Employee' # Ссылка на определение объекта
            application/xml: # Тип носителя
             схема:
               $ref: '#/components/schemas/Employee' # Ссылка на определение объекта
компоненты:
  схемы:
    Сотрудник: # Определение объекта
      тип: объект
      характеристики:
        идентификатор:
          тип: целое число
        имя:
          тип: строка
        на постоянной основе:
          тип: логический

Чтобы определить один и тот же формат для нескольких типов мультимедиа, вы также можете использовать заполнители, такие как */* , приложение/* , изображение/* или другие:

  путей:
  /информация/логотип:
    получать:
      ответы:
        '200': # Ответ
          описание: хорошо
          content: # Тело ответа
            image/*: # Тип носителя
             схема:
               тип: строка
               формат: двоичный

Значение, которое вы используете в качестве типа мультимедиа — image/* в нашем примере — очень похоже на то, что вы можете увидеть в заголовках Accept или Content-Type HTTP-запросов и ответов.

Media type: MIME types — HTTP | MDN