Імпорт моделі Smithy
Smithy — це мова моделювання API від AWS. Restorm імпортує обидва її подання.
Імпорт
Section titled “Імпорт”Файл ▸ Імпортувати (Ctrl+I), а потім:
- файл
.smithy(мова моделювання); - або AST JSON, отриманий командою
smithy build.
Обидва шляхи сходяться до тієї самої внутрішньої моделі.
Що імпортується
Section titled “Що імпортується”| Елемент | Що з нього робить 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 пропускаються.
Оновлення
Section titled “Оновлення”Smithy належить до форматів, придатних до повторної синхронізації. Див. Оновлення з джерела.