API-de arhitektuuristiil - kuidas teha valik

Uue API ehitamisel on nii palju valikuvõimalusi. Millise arhitektuuristiili peaksime valima oma uue laheda API jaoks? Kas on API-de arhitektuuristiili osas parimaid tavasid?

Kuid kõigepealt, mis on arhitektuuristiil? Üldiselt on arhitektuuristiil suuremahuline, eelnevalt määratletud lahendusstruktuur. Arhitektuuristiile on peaaegu kõigil, näiteks majade ehitamisel, tarkvara ehitamisel ja eriti API-de ehitamisel. Arhitektuuristiili kasutamine aitab meil lahenduse kiiremini kujundada kui kõike nullist kavandades.

Arhitektuuristiilid pakuvad etteantud lahenduselemente ja on seega sarnased kujundusmustrite või kujundusmallidega. Kui projekteerimisharjumusi ja -malle kasutatakse sageli kohalike rakendusprobleemide lahendamiseks, näiteks itereerimine nimekirja kaudu, pakuvad arhitektuuristiilid lahenduse suuremale väljakutsele. Arhitektuuristiili kasuks otsustamine on kaugeleulatuv ja läbib kogu lahenduse.

Arhitektuuristiilide valik peaks olema üks esimesi otsuseid uue API ehitamisel, kuna see on otsus, mida on hiljem raske muuta.

  • REST API stiil (esinduslik riigiülekanne) HATEOAS-iga kõigil selle "tasemetel", nagu on määratletud Richardsoni küpsusindeksis.
  • GraphQL API stiil
  • RPC API stiil (Remote Procedure Call)
  • SOAP API stiil
  • gRPC API stiil
  • Falcori API stiil

API-sid saab põhimõtteliselt realiseerida, kasutades mõnda neist arhitektuuristiilidest. Kuidas me teame, kas konkreetne stiil sobib antud API-le? Saadud API paljastab paljusid soovitavaid omadusi.

Parimad tavad API-de arhitektuurilise stiili osas

Parim tava on API-de realiseerimine REST-i arhitektuuristiili kasutades. See on ka kõige tavalisem stiil. Seetõttu võib praktikas eeldada, et API-sid realiseeritakse REST-stiiliga. Kas soovite õppida REST-stiili API kujundamisel? Vaadake RESTful API kujundusraamatut.

Algselt avaldati API-ülikoolis.