İçeriğe geç

Smithy modelini içe aktarma

Smithy, AWS’nin API modelleme dilidir. Restorm onun iki gösterimini de içe aktarır.

Dosya ▸ İçe aktar (Ctrl+I), ardından:

  • bir .smithy dosyası (modelleme dilinin kendisi);
  • ya da smithy build komutunun ürettiği JSON AST.

İkisi de aynı iç modelde birleşir.

ÖğeRestorm’un yaptığı
Her service / resourceBir klasör
@http taşıyan her işlemBir HTTP isteği
@httpLabelBir yol parametresi
@httpQueryBir sorgu parametresi
@httpHeaderBir başlık
Dokümantasyon ve türlerAPI dokümantasyonu ve numaralandırmalar

Sınırlar (içe aktarmanın 1. sürümü)

Section titled “Sınırlar (içe aktarmanın 1. sürümü)”
  • @http niteliği olmayan bir işlem yalnızca belgeseldir: API dokümantasyonunda görünür ama istek üretmez.
  • SigV4 kimlik doğrulaması önceden bağlanmaz: onu elle yapılandırın.
  • REST dışı protokol bağlamaları (awsJson1_1, awsQuery…) modellenmez.
  • Listeler, eşlemeler ve birleşimler birinci sınıf biçimler değildir.
  • Doğrulama nitelikleri (@pattern, @length, @paginated, @readonly…) sessizce yok sayılır.
  • Smithy protokol testleri yok sayılır.

Smithy, yeniden eşitlenebilir biçimler arasındadır. Bkz. Kaynaktan güncelleme.