Lewati ke konten

Mengimpor model Smithy

Smithy adalah bahasa pemodelan API milik AWS. Restorm mengimpor kedua representasinya.

File ▸ Impor (Ctrl+I) lalu pilih:

  • sebuah file .smithy (bahasa pemodelannya);
  • atau AST JSON yang dihasilkan smithy build.

Keduanya bermuara pada model internal yang sama.

ElemenYang dibuat Restorm darinya
Setiap service / resourceSebuah folder
Setiap operasi yang membawa @httpSebuah permintaan HTTP
@httpLabelSebuah parameter jalur
@httpQuerySebuah parameter kueri
@httpHeaderSebuah header
Dokumentasi dan tipeDokumentasi API dan enumerasi
  • Operasi tanpa trait @http bersifat dokumentasi saja: ia muncul di dokumentasi API tetapi tidak menghasilkan permintaan.
  • Autentikasi SigV4 tidak terpasang otomatis: konfigurasikan secara manual.
  • Pengikatan protokol non-REST (awsJson1_1, awsQuery…) tidak dimodelkan.
  • Daftar, kamus, dan union bukan bentuk kelas satu.
  • Trait validasi (@pattern, @length, @paginated, @readonly…) diabaikan diam-diam.
  • Uji protokol Smithy diabaikan.

Smithy termasuk format yang dapat disinkronkan ulang. Lihat Memperbarui dari sumber.