Можно ли определить повторно используемую операцию пути?

Мы добавляем поддержку CORS в наш Swagger API, который включает определение операции параметров для каждого пути. Поскольку это шаблонный код, мы хотим определить операцию опции один раз в разделе определений, например так:

"definitions":{  
 "CORS":{ .. }
 }

И затем ссылайтесь на операцию в наших путях, например так

"paths":{  
      "/system/info":{  
        "options" : {
           "$ref": "#/definitions/CORS"
       }
    }
}

Это не работает, когда мы загружаем определение чванства. Каков правильный способ достижения нашей цели — определить операцию пути один раз, а затем повторно использовать ее в разных путях?


person Kenoyer130    schedule 20.01.2016    source источник


Ответы (1)


Вы можете сослаться на весь путь к внешнему местоположению:

"paths": {
  "/system/info": {
    "$ref": "cors.json"
  }
}

но не отдельный метод http. Кроме того, спецификация не допускает относительной ссылки на путь — вам придется поместить ее в отдельный документ.

См. здесь информацию об объекте элемента пути. и здесь для объект чванства уровня.

person fehguy    schedule 21.01.2016