Gå til indhold

Importér en Smithy-model

Smithy er AWS’ modelleringssprog til API’er. Restorm importerer begge dets repræsentationer.

Fil ▸ Importér (Ctrl+I), og derefter:

  • en .smithy-fil (modelleringssproget);
  • eller det JSON-AST, som smithy build producerer.

Begge fører frem til den samme interne model.

ElementHvad Restorm gør med det
Hver service / resourceEn mappe
Hver operation med @httpEn HTTP-anmodning
@httpLabelEn stiparameter
@httpQueryEn forespørgselsparameter
@httpHeaderEn header
Dokumentation og typerAPI-dokumentationen og opremsningerne
  • En operation uden @http-trait er kun dokumentarisk: den optræder i API-dokumentationen, men den producerer ingen anmodning.
  • SigV4-godkendelse forudkobles ikke: konfigurér den i hånden.
  • Protokolbindinger, der ikke er REST (awsJson1_1, awsQuery …), modelleres ikke.
  • Lister, ordbøger og unioner er ikke førsteklasses former.
  • Valideringstraits (@pattern, @length, @paginated, @readonly …) ignoreres i stilhed.
  • Smithys protokoltests ignoreres.

Smithy er blandt de formater, der kan gensynkroniseres. Se Opdatér fra kilden.