OpenAPI模式的媒体类型是什么?

时间:2018-09-27 16:56:19

标签: swagger openapi media-type

每当搜索此内容时,我都会找到有关如何指定架构定义的资源的媒体类型的资源,但是找不到关于架构本身的实际媒体类型是什么的答案。

考虑到HTTP的工作方式,对我来说有意义的是,如果我使用Accept标头请求正确的内容类型,则服务器可以适当地响应。

因此,如果我用/products请求Accept: application/json,我将获得JSON格式的产品,但是如果我请求openapi-whatever,则将获得OpenAPI模式。

认为我可能可以使用application/openapi+jsonapplication/openapi+yaml,但在实际的specification中却看不到任何东西。

我不确定是否真的要使用Accept标头来解决这种区别,但是无论如何,我当然想使用正确的Content-Type标头进行响应。

1 个答案:

答案 0 :(得分:2)

OpenAPI Initiative的技术指导委员会(TSC)approved以下媒体类型:

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

带有可选的version参数:

application/vnd.oai.openapi;version=2.0

但是,这些媒体类型尚未在IANA中注册。