Aller au contenu

Dizajnuesi i API-ve

Dizajnuesi i API-ve ju lejon të projektoni një API të plotë drejtpërdrejt brenda Restorm: ju përshkruani të dhënat dhe rrugët tuaja, ndërsa Restorm kujdeset për pjesën tjetër — ai shërben dizajnin tuaj si një server mock i vërtetë dhe gjeneron kodin e aplikacionit tuaj nga template-t.

Është mjeti ideal për të nisur një API përpara se back-end-i të ekzistojë: skiconi kontratën, lëreni klientët tuaj ta testojnë dhe mbajeni gjithçka të versionuar brenda projektit tuaj.

Vështrim i përgjithshëm i dizajnuesit të API-ve: shiriti anësor liston modelet, enum-et, rrugët, serverin, klientët dhe kodin

Një dizajn krijohet si çdo element tjetër: klik i djathtë mbi një dosje ▸ Shto ▸ Dizajn API. Ai hapet në skedën e vet dhe grupon disa seksione, të qasshme nga shiriti anësor:

SeksioniPër çfarë shërben
ModeletEntitetet tuaja dhe vetitë e tyre — shihni Modelet, enum-et dhe vetitë.
Enum-etGrupe vlerash të mbyllura, të ripërdorshme si tip vetie.
RrugëtPikat e hyrjes së API-t, të grupuara sipas burimit — shihni Rrugët & CRUD.
ServeriShërbeni dizajnin si mock, në HTTP, GraphQL, SOAP, OData ose gRPC — shihni Shërbimi i dizajnit si mock.
KlientëtKërkesa gati për përdorim që thërrasin mock-un në ekzekutim — shihni Klientët.
Dokumentacioni & ShënimetDokumentacion dhe shënime të lira të bashkangjitura dizajnit.
KodiGjenerimi i kodit nga template-t tuaja — shihni Gjenerimi i kodit.

Cilësimet e dizajnit (emri, vlerat e paracaktuara) hapen duke klikuar drejtpërdrejt mbi nyjen e dizajnit në shiritin anësor.

  1. Përshkruani të dhënat tuaja — krijoni modelet dhe enum-et tuaja, shtoni vetitë, tipet dhe kufizimet e tyre.
  2. Përcaktoni rrugët tuaja — me dorë, ose me një klik me Gjenero CRUD nga një model.
  3. Shërbeni mock-un — nisni serverin dhe drejtojini aplikacionin ose një klient drejt tij. I njëjti dizajn projektohet automatikisht në çdo protokoll të aktivizuar.
  4. Gjeneroni kodin — zgjidhni një ose disa template (tuajat ose ato të propozuara nga Restorm) dhe prodhoni projektin përkatës.

Çdo hap është detajuar në faqet e këtij seksioni.