$ ref не работает при использовании нескольких вложенных файлов при сборке документации по swagger.

Question

Я не уверен, что я сейчас не в курсе, но я несколько раз сталкивался с Swagger и пытаюсь настроить мои чтобы я мог разделить документацию на более мелкие, более управляемые файлы. Однако, что я нашел, когда я пытаюсь сделать $ref файл внутри другого файла, который я уже использовал $ref, похоже, он не работает.

Я создал страницу с Форс-UI работает, так что вы можете увидеть http://jer-k.github.io/swagger-docs-testing/swagger-ui/?url=http://jer-k.github.io/swagger-docs-testing/docs/api.swagger.yaml (репо https://github.com/jer-k/swagger-docs-testing)

Если посмотреть в api.swagger.yaml на первом пути, я использую

schema: $ref: "./schema/trade-report.yaml"

И если вы просмотрите раздел TradeReport в Swagger-UI, вы увидите, что схема правильно загружена в качестве параметра.

Затем, если вы посмотрите в api.swagger.yaml во втором пути я загружаю его через $ref

"/payments/calculate": $ref: './calculate.yaml'

И если мы посмотрим в calculate.yaml я снова ссылающегося отчет о торговле

schema: $ref: "./schema/trade-report.yaml"

Но просмотрев путь расчета в разделе «Платежи в Swagger-UI», параметр установлен неправильно. Он имеет Data Type: http://jer-k.github.io/swagger-docs-testing/docs/./calculate.yaml#./schema/trade-report.yaml

Я действительно смущен, почему это происходит. Любая помощь будет оценена!

Answer 1

@TheJer попытается ограничить использование $ref только определениями схемы и проверить его.

Answer 2

@TheJer, хорошо, я узнал больше за последние 24 часа. Так что, обращаясь к вам :)

Существует проблема с Swagger-UI, разрешающим вложенный $ ref. Я столкнулся с той же проблемой и зарегистрировал выпуск #1943. Надеемся, что все начнет работать, как только проблема будет решена.