Перейти до вмісту

Імпорт моделі Smithy

Smithy — це мова моделювання API від AWS. Restorm імпортує обидва її подання.

Файл ▸ Імпортувати (Ctrl+I), а потім:

  • файл .smithy (мова моделювання);
  • або AST JSON, отриманий командою smithy build.

Обидва шляхи сходяться до тієї самої внутрішньої моделі.

ЕлементЩо з нього робить Restorm
Кожен service / resourceТеку
Кожну операцію з @httpЗапит HTTP
@httpLabelПараметр шляху
@httpQueryПараметр запиту
@httpHeaderЗаголовок
Документацію й типиДокументацію API та переліки

Обмеження (версія 1 імпорту)

Section titled “Обмеження (версія 1 імпорту)”
  • Операція без ознаки @http є суто документаційною: вона з’являється в документації API, але не породжує запиту.
  • Автентифікація SigV4 заздалегідь не під’єднується: налаштуйте її вручну.
  • Прив’язки до протоколів, відмінних від REST (awsJson1_1, awsQuery…), не моделюються.
  • Списки, словники та об’єднання не є формами першого рівня.
  • Ознаки перевірки (@pattern, @length, @paginated, @readonly…) тихо пропускаються.
  • Протокольні тести Smithy пропускаються.

Smithy належить до форматів, придатних до повторної синхронізації. Див. Оновлення з джерела.