Smithy-modell importálása

A Smithy az AWS API-modellező nyelve. A Restorm mindkét ábrázolását importálja.

Importálás

Fájl ▸ Importálás (Ctrl+I), majd:

• egy .smithy fájl (a modellező nyelv);
• vagy a smithy build által előállított JSON AST.

Mindkettő ugyanabba a belső modellbe fut össze.

Az importált elemek

Elem	Amit a Restorm készít belőle
Minden service / resource	Egy mappa
Minden @http jelöléssel ellátott művelet	Egy HTTP-kérés
@httpLabel	Egy útvonalparaméter
@httpQuery	Egy lekérdezési paraméter
@httpHeader	Egy fejléc
Dokumentáció és típusok	Az API-dokumentáció és a felsorolások

Korlátok (az importálás 1. verziója)

• A @http jelölés nélküli művelet csak dokumentációs célú: megjelenik az API-dokumentációban, de nem lesz belőle kérés.
• A SigV4 hitelesítés nincs előre bekötve: kézzel kell beállítani.
• A nem REST protokollkötések (awsJson1_1, awsQuery…) nincsenek modellezve.
• A listák, a szótárak és az uniók nem elsőrangú formák.
• Az érvényesítési jelölések (@pattern, @length, @paginated, @readonly…) csendben figyelmen kívül maradnak.
• A Smithy protokolltesztjei figyelmen kívül maradnak.

Frissítés

A Smithy az újraszinkronizálható formátumok közé tartozik. Lásd: Frissítés a forrásból.