当前位置: 首页 > 知识库问答 >
问题:

“内容”:在Swagger/OpenAPI“响应”中是什么意思:

逄嘉木
2023-03-14

使用Swagger/OpenAPI(以及随后的swagger-codegen)我还没能找到两者之间的区别

这是从https://swagger.io/specification/#responseSobject(第一个示例,json格式)中获得的Directy

"responses" : {
  "200": {
    "description": "a pet to be returned",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Pet"
} } } } }

"responses" : {
  "200": {
    "description": "a pet to be returned",
    "schema": {
      "$ref": "#/components/schemas/Pet"
} } }
responses:
  200:
    description: "a pet to be returned"
responses:
  200:
    description: "a pet to be returned"
    schema:
      $ref: "#/components/schemas/Pet"

内容是什么意思?我在这个示例中遗漏了什么,为什么内容没有导致非none返回类型和相应的模式。

关于swaggercodgen的注意事项:生成的代码与生成的yaml所说的完全匹配,因此我在这里没有包含任何这些细节

共有1个答案

曾皓
2023-03-14

第一个示例是OpenAPI3.0,第二个示例是OpenAPI2.0,因此不同。

OpenAPI3.0中使用的content关键字替代了OpenAPI2.0中的consumes/produces。在responsessions上下文中,content表示响应具有正文并指定媒体类型(json/xml/等)和响应体的结构。

OpenAPI 2.0版本:

swagger: "2.0"
...
paths:
  /foo:
    get:
      produces:
        - application/json
      responses:
        200:
          description: OK
          schema:
            $ref: "#/definitions/Pet"
openapi: 3.0.0
...
paths:
  /foo:
    get:
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pet"
    null
 类似资料:
  • 问题内容: 我发现这种语法在Facebook上用于Ajax调用。我对回应的开始感到困惑。它是干什么用的? 这是呼叫和响应: 响应: 问题答案: 我有点晚了,TJ基本上解决了这个谜,但是我想我会在这个特定主题上分享一篇很好的论文,其中提供了很好的示例并提供了对该机制的更深入的了解。 这些无限循环是针对“ Java劫持”的一种对策,Jeremiah Grossman 发布了针对Gmail的一种攻击,这

  • 问题内容: 我已经看到了声明,接口和类 这是什么意思? 问题答案: 没有证据,我相信您在谈论Java的泛型支持… 泛型允许您抽象类型 在Java 5之前,很难提供能够支持多种不同类型的Objects的类而不必为每种特定情况编写代码,因此人们通常会这样做。 这导致在运行时做出许多困难的选择,您必须进行运行时检查以查看是否有可能将给定的Object强制转换为可用类型…例如 现在,这已经很明显了,但是如

  • 在OpenAPI/Swagger文件中声明“char”的正确方法是什么?我试过这些..但不起作用 我也很累,但运气不好

  • 我的Symfony 4应用程序中有一个APIendpoint,我想用NelmioApiDocBundle和Swagger记录它。endpoint将JSON作为请求数据,并返回一些自定义JSON作为响应。如何使用注释将其示例添加到文档中?我在文档页面上看不到任何示例,只有描述。

  • 问题内容: 在Linux内核源代码中,我找到了以下功能: 在这里我不明白这意味着什么。 问题答案:

  • 问题内容: 什么是在这个CSS规则是什么意思? 问题答案: 是相邻的同级组合器。 这意味着选择只选择自带 之后 的。 插图: 选择了什么,没有选择什么: 选择 这个来之后第一。 未选择 这出现在第一后而不是在。由于它不会立即跟随,因此未选中。 但是,由于它仍然紧随元素之后,选择器不会立即匹配此元素,而是将使用通用的同级组合器来匹配该元素。 未选择 这位于内,并且在引号内没有满足其选择器的内容。