$ ref和架构之间的区别:开放API规范2中的{$ ref:'#/ definiations / blah / blah'}

时间:2019-10-22 08:31:02

标签: yaml swagger swagger-2.0 openapi swagger-editor

我正在编写逻辑以解析API YAML文件以生成API文档,类似于swagger。

我对“ $ ref”的使用感到困惑。

  

情况1:“模式”下的“ $ ref”,如下所示。

"responses": {
  "200": {
    "description": "The response",
    "schema": {
      "$ref": "#/definitions/TokenResponse" 
    }
  }
}
  

情况-2:直接在响应代码下的$ ref

"responses": {
  "302": {"$ref": "#/definitions/AuthorizeResponse"}
}

根据我的理解,case-1指的是JSON对象,而case-2指的是未定义架构的对象,并且大多只是具有“描述”值。

请对此进行说明。我尝试阅读OPen API规范,但没有明确的答案。

0 个答案:

没有答案