RAML resourceTypes и трейты VS Swagger $ref

Мне очень нравится, как RAML фокусируется на уменьшении дублирования и повышении согласованности между API с использованием ResourceTypes и Traits.

Но после более внимательного изучения спецификации Swagger оказывается, что вы можете сделать то же самое, используя $ref.

Есть ли в этом сценарии преимущество RAML над $ref? Я что-то упускаю?


person Johnny Z    schedule 24.01.2015    source источник


Ответы (1)


После того, как я изучил это подробнее, у меня появилось лучшее понимание того, как это работает.

Одно большое отличие заключается в том, что типы ресурсов в RAML принимают параметры, что позволяет извлекать больше кода.

Кроме того, есть ограничения, где вы можете использовать $ref в чванстве. Это означает, что вы не можете применять $ref на уровне ресурсов или в http-методах. Примерами вещей, которые вы можете воплотить в жизнь, являются параметры, ответы и модели.

ResourceTypes и Traits более эффективны для экстернализации общих шаблонов в REST и их повторного использования в разных службах.

person Johnny Z    schedule 27.01.2015
comment
Я использую черты для определения спецификации нескольких заголовков в RAML. У меня есть несколько заголовков, которые повторно используются во многих ресурсах. Сейчас пытаюсь перейти с RAML на чванство. Копирование встроенных определений заголовков кажется мне полным излишеством. Знаете ли вы, могу ли я повторно использовать трейты для заголовков в swagger? - person ducin; 20.02.2016