swagger - OpenAPI 架构的媒体类型是什么?

标签 swagger openapi media-type

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

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

因此,如果我使用 Accept: application/json 请求 /products,我将获得 JSON 格式的产品,但如果我请求 openapi-whatever code> 我会得到 OpenAPI 架构。

认为我可能可以使用application/openapi+jsonapplication/openapi+yaml,但我看不到任何东西关于它的实际specification .

我不确定我是否真的想使用 Accept header 来实现此差异,但在任何情况下我当然希望使用正确的 Content-Type header 进行响应。

最佳答案

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

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

带有可选的版本参数:

application/vnd.oai.openapi;version=2.0

但是,这些媒体类型尚未注册到 IANA .

关于swagger - OpenAPI 架构的媒体类型是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/52541842/

相关文章:

c# - 如何在请求 header 中使用 Swashbuckle 设置多个 api Key

javascript - NestJS/Swagger : what model is the ApiExtraModel expecting as a parameter?

java - RESTful Web 服务为 POST 请求返回不支持的媒体类型

asp.net-core - Swagger 将 IFormFile 参数列为类型 "object"

node.js - express-openapi-validator:错误:TypeError:无法读取未定义的属性 'schema'

java - 对基于 Java 的 REST Web 服务进行版本控制?

c# - 远程服务器返回错误 : (415) Unsupported Media Type

c# - WebApi 和使用 Swagger

android - 如何使用 swagger 从 wp rest api 生成 Retrofit 客户端库

swagger codegen 在生成的文件中覆盖我的自定义代码