Какой тип носителя схемы OpenAPI? - PullRequest
0 голосов
/ 27 сентября 2018

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

Учитывая работу HTTP, для меня имеет смысл, что если я запрашиваю правильный тип контента с заголовком Accept, мой сервер может ответить соответствующим образом.

Таким образом, если я запрашиваю /products с Accept: application/json Iполучал бы продукты в формате JSON, но если бы я запросил openapi-whatever, я бы получил схему OpenAPI.

I думаю Возможно, я могу использовать либо application/openapi+json, либо application/openapi+yaml, но яЯ не вижу ничего об этом в действительной спецификации .

Я не уверен, хочу ли я использовать заголовок Accept для этой разницы, но я определенно хочу ответитьс правильным заголовком Content-Type в любом случае.

1 Ответ

0 голосов
/ 27 сентября 2018

Технический руководящий комитет Инициативы OpenAPI (TSC) одобрил следующие типы носителей:

application/vnd.oai.openapi      (YAML variant)
application/vnd.oai.openapi+json (JSON only variant)

с необязательным параметром version:

application/vnd.oai.openapi;version=2.0

Однако эти типы носителей еще не зарегистрированы в IANA .

...