Разница между $ ref и схемой: {$ ref: '# / Definitions / Blah / Blah'} в открытых API-спецификации 2 - PullRequest
Новая
       63

Разница между $ ref и схемой: {$ ref: '# / Definitions / Blah / Blah'} в открытых API-спецификации 2

0 голосов
/ 22 октября 2019

Я пишу логику для анализа файлов API YAML для генерации документации API, аналогичной swagger.

Я запутался с использованием "$ ref".

Случай 1: "$ ref" в разделе "схема", как показано ниже. 

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

Случай -2: $ ref непосредственно под ответомcode 

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

Согласно моему пониманию, case-1 ссылается на объект JSON, а case-2 ссылается на объект, для которого не определена схема, и в большинстве случаев просто имеет значение "description".

Пожалуйста, пролите немного света на это. Я пытался читать спецификации OPen API, но однозначного ответа не было.

...