Pregled posta

Adresa bloga: https://blog.dnevnik.hr/kako-radi

Marketing

Uvod u Blog.hr API (1)

Svaki predložak na Blog.hr–u mora sadržavati posebne programske instrukcije kako bi ispravno prikazivao sadržaj bloga. Ove instrukcije nalikuju HTML–u, stoga je za njihovu pravilnu upotrebu potrebno osnovno poznavanje HTML–a.

Što je API?

Skup programskih instrukcija sačinjava API neke aplikacije. Prema definiciji, API je programsko sučelje za izradu aplikacija koje se sastoji od skupa standardiziranih instrukcija i naredbi. Programer može koristiti API nekog softvera kako bi modificirao ili kreirao novu funkcionalnost, dok pritom ne mora poznavati unutrašnje zakonitosti platforme čiji API koristi. Nadalje, API je model pomoću kojeg jedna aplikacija komunicira s drugom, bez direktnog posredstva korisnika. To u praksi znači da dizajnirani predložak bloga komunicira s programskim kôdom na poslužitelju i automatski ispisuje željeni sadržaj: postove, kalendar arhive postova, aplikaciju za komentiranje… sve elemente koje je dizajner stranice napisao koristeći API Blog.hr–a, a da programskom kôdu uopće nije pristupio.

Pravila Blog.hr API–ja

Budući da mu je namjena ispis sadržaja unutar HTML kôda, API je prilično jednostavan i sastoji se od 30–većih i manjih segmenata (blokova i varijabli) koji se pišu prema ovim pravilima:

  • veći blokovi su formatirani kao HTML elementi, imaju početnu i završnu oznaku (tag) i prate standardnu HTML sintaksu;
  • u sebi sadrže druge blokove i varijable:
<_!-- primjer pisanja bloka -->
<_NazivBloka>...<_/NazivBloka>

<_!-- primjer HTML sintakse s blokovima i varijablama -->
<_VelikiBlok>

<_MaliBlok>
<_$Varijabla1$>
<_/MaliBlok>

<_$Varijabla2$>

<_/VelikiBlok>
  • varijable su formatirane kao jedna samostalna pseudoHTML oznaka unutar dolarskih simbola:
<_$ImeVarijable$>
  • tagovi i varijable moraju se pisati bez bjelina, a pri pisanju se mora paziti na velika i mala slova. Ovo je pogrešno:
<_Naziv Bloka><_ / nazivbloka >
<_$ naziv varijable $>

Kako API generira HTML kôd

Za to je zadužen sustav programskih predložaka (templating system ili templating engine), poseban program koji posreduje između HTML predloška s API naredbama i programa na poslužitelju, a svrha mu je razdvajanje programskog i prezentacijskog dijela te pojednostavljivanje rada. To znači da programer ne treba brinuti kako će rezultat izgledati u pregledniku već je to posao dizajnera predloška.

Ovaj programski međusloj funkcionira u komunikaciji s glavnim programom na poslužitelju koji ‘iščitava’ dizajnerski predložak s API instrukcijama na čije mjesto potom ubacuje pripremljene podatke iz baze i nakon toga ih u HTML formatu ispisuje u preglednik. Svaki blok je stoga svojevrsni mikropredložak s vlastitim podacima i prezentacijskim instrukcijama, gdje primjerice <_Blog><_/Blog> i <_$Kalendar$> mogu imati složenu HTML strukturu, dok varijabla <_$DatumPosta$> sadrži samo jedan podatak.



Post je objavljen 23.12.2009. u 12:34 sati.