Importera en Smithy-modell
Smithy är AWS:s modelleringsspråk för API:er. Restorm importerar båda dess representationer.
Importera
Section titled “Importera”Arkiv ▸ Importera (Ctrl+I) och sedan:
- en
.smithy-fil (modelleringsspråket); - eller det JSON-AST som
smithy buildskapar.
Båda mynnar ut i samma interna modell.
Vad som importeras
Section titled “Vad som importeras”| Element | Vad Restorm gör av det |
|---|---|
Varje service / resource | En mapp |
Varje operation som bär @http | En HTTP-begäran |
@httpLabel | En sökvägsparameter |
@httpQuery | En frågeparameter |
@httpHeader | En header |
| Dokumentation och typer | API-dokumentationen och uppräkningarna |
Begränsningar (version 1 av importen)
Section titled “Begränsningar (version 1 av importen)”- En operation utan traiten
@httpär enbart dokumenterande: den syns i API-dokumentationen men ger ingen begäran. - Autentiseringen SigV4 kopplas inte in i förväg: konfigurera den för hand.
- Protokollbindningar som inte är REST (
awsJson1_1,awsQuery…) modelleras inte. - Listor, ordböcker och unioner är inte förstaklassiga former.
- Valideringstraits (
@pattern,@length,@paginated,@readonly…) ignoreras tyst. - Smithys protokolltester ignoreras.
Uppdatera
Section titled “Uppdatera”Smithy är ett av de format som går att synkronisera om. Se Uppdatera från källan.