Pieskovisko

oceľ, norky, hovädzie mäso, papier 26. novembra 2012 o 13:59

Čo je API

pozdravujem!
V tomto článku sa pozrieme na to, čo je API, kde, ako a na čo sa používa. Pozrieme sa tiež na to, ako sa dá API použiť pri vývoji webu a ako môže zjednodušiť život webovým programátorom.

Začnime teda definíciou. API (Application Programming Interface) je programovacie rozhranie, rozhranie na vytváranie aplikácií. V zrozumiteľnejšom jazyku je API hotový kód na zjednodušenie života programátora. API bolo vytvorené tak, aby programátor mohol skutočne uľahčiť úlohu písania aplikácie pomocou hotového kódu (napríklad funkcií). Známy jQuery napísaný v JavaScripte je tiež akýmsi API. Ak vezmeme do úvahy tento konkrétny príklad, potom jQuery značne uľahčuje písanie kódu. To, čo by sa dalo urobiť za 30 riadkov s bežnými JavaScriptovými prostriedkami, je napísané cez jQuery v 5-6. Ak sa pozrieme na API vo všeobecnosti, potom môžete nájsť množstvo služieb, ktoré predstavujú riešenia pre vývoj. Najznámejšia je dnes služba code.google.com, ktorá poskytuje asi päťdesiat rôznych API! Ide o rozhranie na vytváranie aplikácií pre Android a rôzne API pre prácu s AJAX a rôzne aplikačné API, ktoré si môžete jednoducho prispôsobiť podľa svojich predstáv.

Koniec koncov, má zmysel písať kód vlastnými rukami? Prečo pracovať na tom, čo už bolo vytvorené? Má zmysel vzdať sa bezplatných riešení (a vlastne bezplatnej pomoci) pri vývoji webu? Ak ste na všetky tieto otázky odpovedali „NIE“, predpokladajte, že rozumiete podstate API.

Ale tiež chcem urobiť rezerváciu. Začiatočníci vývojári by NEMALI používať polotovary, pretože v budúcnosti nezvládnu skutočnú úlohu. Preto ak ste začínajúci webový programátor, tak nepoužívajte polotovary! Naučte sa myslieť vlastnou hlavou, vytvorte rôzne algoritmy, aby ste pochopili podstatu programovania. Tiež hovorím, už teraz všetkým, že API nie sú hotové riešenia, je to prostredie, rozhranie na vytváranie vašich projektov. Ty neješ mrazené hamburgery z obchodu, však? Najprv ich opečieš, však? Táto analógia je veľmi jasná o podstate API.

Vo všeobecnosti som vám povedal, čo je API, kde a ako sa používa, najdôležitejšia vec na čo. Prajem vám príjemné štúdium programovania webu a pochopenie jeho stále väčších hĺbok!

Tagy: api

Tento článok nie je predmetom komentára, keďže jeho autor ešte nie je riadnym členom komunity. Autora budete môcť kontaktovať až po prijatí

API definuje funkcionalitu, ktorú program (modul, knižnica) poskytuje, pričom API umožňuje abstrahovať od toho, ako presne je táto funkcionalita implementovaná.

Ak sa program (modul, knižnica) považuje za čiernu skrinku, potom API je súbor „knobov“, ktoré má používateľ tejto skrinky k dispozícii a ktoré môže krútiť a ťahať.

Softvérové ​​komponenty navzájom spolupracujú prostredníctvom rozhraní API. V tomto prípade komponenty zvyčajne tvoria hierarchiu - komponenty na vysokej úrovni používajú API komponentov nižšej úrovne a tie zase používajú API komponentov ešte nižšej úrovne.

Podľa tohto princípu sú zostavené protokoly prenosu údajov. Štandardný internetový protokol (model siete OSI) obsahuje 7 vrstiev (od fyzickej vrstvy prenosu bitových paketov po vrstvu aplikačných protokolov ako HTTP a IMAP). Každá vrstva využíva funkčnosť predchádzajúcej vrstvy prenosu údajov a následne poskytuje požadovanú funkčnosť ďalšej vrstve.

Je dôležité poznamenať, že pojem protokol je svojím významom blízky pojmu API. Obidve sú abstrakcie funkčnosti, iba v prvom prípade hovoríme o prenose údajov av druhom o vytváraní počítačových aplikácií.

Rozhranie API knižnice funkcií a tried obsahuje popis podpisov a sémantika funkcie.

Application Programming Interface (API) je programovacie rozhranie pre interakciu medzi systémami, ktoré umožňuje:

• Prístup k podnikovým obchodným službám
• Výmena informácií medzi systémami a aplikáciami
• Zjednodušte interakcie medzi spoločnosťami, partnermi, vývojármi a zákazníkmi

Otvorená stratégia API

Stratégia API zahŕňa:

• Vývoj obchodných produktov založených na existujúcich API
• Poskytovanie interných služieb vývojárom
• Modely monetizácie API na vytváranie viackanálových interakcií a zvyšovanie ziskov

Implementácia konceptu Open API pomáha transformovať biznis, zakotviť ho do flexibilného projektového ekosystému hráčov na trhu, vytvárať podmienky pre neustále generovanie nových nápadov a formovanie pridanej hodnoty pri správe firemných dátových polí.

Trh s integračnými riešeniami sa rozvíja v kontexte evolúcie API – od EDI a SOAP po Web 2.0, ktorý začal éru verejných API. Počet takýchto rozhraní môže v nasledujúcich 3 rokoch vzrásť viac ako 50-krát a dosiahnuť 1 milión. Je to kvôli viackanálovému: kanály interakcie so zákazníkmi sa musia meniť s nimi. Neustály rast počtu spotrebiteľov a objemu údajov viedol k vzniku API ekonomiky, ktorá pomáha vytvárať inovatívne obchodné modely na využívanie podnikových aktív a služieb založených na otvorených rozhraniach.

Podpis funkcie

Podpis funkcie- časť deklarácie všeobecnej funkcie, ktorá umožňuje vysielateľom identifikovať funkciu medzi ostatnými. Rôzne programovacie jazyky majú rôzne predstavy o podpise funkcie, čo tiež úzko súvisí s možnosťami preťaženia funkcií v týchto jazykoch.

Niekedy rozlišovať volací podpis a implementačný podpis funkcie. Signatúra volania sa zvyčajne vytvára zo syntaktickej štruktúry volania funkcie, pričom sa berie do úvahy podpis rozsahu danej funkcie, názov funkcie, postupnosť skutočných typov argumentov vo volaní a typ volania. výsledok. Podpis implementácie zvyčajne obsahuje niektoré prvky zo syntaktickej konštrukcie deklarácie funkcie: špecifikátor rozsahu funkcie, jej názov a postupnosť formálnych typov argumentov.

Napríklad v programovacom jazyku C++ je jednoduchá funkcia jednoznačne rozpoznaná kompilátorom podľa jej názvu a postupnosti typov jej argumentov, čo tvorí podpis funkcie v tomto jazyku. Ak je funkcia metódou nejakej triedy, potom bude v podpise zahrnutý aj názov triedy.

Treba tiež poznamenať, že programátor má často k dispozícii niekoľko rôznych API, ktoré umožňujú dosiahnuť rovnaký výsledok. Každé API je však zvyčajne implementované pomocou API softvérových komponentov nižšej úrovne abstrakcie.

Napríklad: aby ste videli riadok "Ahoj, svet!" všetko, čo musíte urobiť, je vytvoriť HTML dokument s minimálnou hlavičkou a jednoduchým telom obsahujúcim daný reťazec. Čo sa stane, keď prehliadač otvorí tento dokument? Program prehliadača prenesie názov súboru (alebo už otvorený deskriptor súboru) do knižnice, ktorá spracováva dokumenty HTML, ktorá zase pomocou rozhrania API operačného systému prečíta tento súbor a pochopí jeho zariadenie, zavolá operácie ako „Vymazať okno“, „píšte vybraným písmom Hello, world!“ toto“.

Zároveň prakticky na každej z úrovní je vlastne niekoľko možných alternatívnych API. Napríklad: pôvodný dokument by sme mohli napísať nie v HTML, ale v LaTeX-e, na zobrazenie by sme mohli použiť akýkoľvek prehliadač. Rôzne prehliadače vo všeobecnosti používajú rôzne knižnice HTML a navyše to všetko možno (všeobecne povedané) skompilovať pomocou rôznych primitívnych knižníc a na rôznych operačných systémoch.

Hlavné výzvy existujúcich vrstvených systémov API sú teda:

• Zložitosť prenosu programového kódu z jedného systému API do druhého (napríklad pri zmene OS);
• Strata funkčnosti pri prechode z nižšej úrovne na vyššiu. Zhruba povedané, každá „vrstva“ API je vytvorená na uľahčenie niektorých štandardných operácií. Zároveň sa však skutočne sťažuje, prípadne sa stáva zásadne nemožným vykonávať niektoré ďalšie operácie, ktoré poskytuje nižšia úroveň API.

Základné typy API

Interné API

• Prístup k API je poskytovaný iba interným vývojárom
• Aplikácie zamerané na zamestnancov podniku

Obchodné vodiče:

• Dôslednosť vývoja
• Znížené náklady
• Zlepšenie efektívnosti vývoja

Partnerské API

• Rozhrania API sú dostupné iba pre obmedzený počet obchodných partnerov
• Aplikácie sú určené pre koncových spotrebiteľov a firemných používateľov

Obchodné vodiče:

• Automatizácia vývojového procesu
• Rozvoj partnerských vzťahov
• Optimalizácia procesu interakcie s partnermi

Verejné API

Prístup je poskytovaný akémukoľvek externému vývojárovi Aplikácie sú zamerané na koncových používateľov

Obchodné vodiče:

• Vývoj nových služieb
• Vývoj ekosystému
• Viackanálová interakcia

Najznámejšie API

API operačných systémov

GUI API

• Direct3D (časť DirectX)
• DirectDraw (časť DirectX)

V tomto príspevku som sa pokúsil zhromaždiť informácie, ktoré môžu byť užitočné pre testerov, ktorí chcú vedieť, čo je API. Dúfam, že ľudia, ktorí majú skúsenosti s testovaním API, nájdu niečo užitočné pre seba. No, alebo vám aspoň pomôžem nájsť chyby v mojom článku :)
Čo je API

API (Application Programming Interface) je súbor hotových tried, procedúr, funkcií, štruktúr a konštánt poskytovaných aplikáciou (knižnicou, službou) na použitie v externých softvérových produktoch (Wikipedia).

Podľa vlastných slov nám API poskytuje možnosť využívať prácu iných ľudí pre naše vlastné účely. Prvýkrát som sa stretol s API s použitím Windows API ako príkladu. Ide o súbor funkcií, ktoré môže využívať každá aplikácia bežiaca na danom OS. Napríklad môže použiť štandardné funkcie na vykreslenie rozhrania.

Moderné API majú často podobu webových služieb, ktoré poskytujú informácie používateľom (ľudom aj iným webovým službám). Postup výmeny informácií a formát prenosu údajov sú zvyčajne štruktúrované tak, aby obe strany vedeli, ako na seba navzájom pôsobiť.

Na stránke https://dev.hh.ru/ (presnejšie https://github.com/hhru/api/blob/master/docs/general.md) nájdete popis, ako klienti HeadHunter API a služby sa navzájom ovplyvňujú. Napríklad citát zo stránky:

• Všetky API fungujú cez protokol HTTPS.
• Autorizácia sa vykonáva pomocou protokolu OAuth2.
• Všetky údaje sú dostupné iba vo formáte JSON.
• Základná adresa URL - https://api.hh.ru/
• Dátumy sú naformátované podľa normy ISO 8601: RRRR-MM-DDThh: mm: ss ± hhmm

Dobrým príkladom vlastnej dokumentácie je HH API.

Formáty prenosu údajov

Existuje mnoho formátov údajov, ktoré používatelia používajú na interakciu s rozhraním API. Napríklad známy XML. Alebo JSON je ľahký a nekomplikovaný formát, ktorý vyzerá takto:

("id": "0001", "type": "donut", "name": "Torta", "image": ("url": "images / 0001.jpg", "width": 200, "výška" ": 200)) NS o ss Na nižšie uvedených odkazoch môžete vidieť odpovede pochádzajúce MediaWikiAPI , v rôznych formátoch :

JSON:https://en.wikipedia.org/w/api.php?action=query&titles=Albert%20Einstein&prop=info&format=jsonfm
XML: https://en.wikipedia.org/w/api.php?action=query&titles=Albert%20Einstein&prop=info&format=xmlfm
PHP: https://en.wikipedia.org/w/api.php?action=query&titles=Albert%20Einstein&prop=info&format=php ( opatrne, stane sa s hojdačkou súbor)

HTTP r lagols

Zvyčajne NS Pri prístupe k webovému APIpoužitím existujú požiadavky HTTP . PretoMusím povedať aspoň stručne o štandardné metódy, ktoré môžu byť obsiahnuté v HTTP požiadavka . Tieto metódy tiež nazývané HTTP slovesá :

• GET. Asi najobľúbenejší typ žiadosť. Používa sa na príjem alebo čítanie údajov.
• PUT. Vlastné n oh a spo slúži na aktualizáciu zdroja .
• POST. Zvyčajne sa používa na vytvorenie nového zdroja.
• VYMAZAŤ. Vymaže údaje.
• Iné

Ak chceme získať informácie o zdroji,Koho URI http://www.example.com/customers/12345 , môžeme poslať požiadavku:
ZÍSKAJTE http://www.example.com/customers/12345

Ak chceme aktualizovať zdroj - môžeme poslať požiadavku PUT:
PUT http://www.example.com/customers/12345/orders/98765

Webový prehliadač môže odosielať pravidelné požiadavky GET. Na odoslanie iných typov žiadostí môžu byť potrebné skriptovacie jazyky alebo špeciálne nástroje (viac o tom nižšie).

O HTTP metódy možno prečítať podrobnejšie pri na W iki.

HTTP na ódy odpovedí

Server môže odosielať rôzne kódy ako odpoveď na požiadavky používateľov. Môžu to byť chybové kódy alebo jednoducho kódy, ktoré informujú používateľov o stave servera. Podrobný popis nájdete opäť na wiki.

Najznámejšie kódy sú 4xx (problémy na strane klienta) a 5xx (problémy na strane servera). O tom, ktoré kódy sa v danej situácii vrátia, rozhodujú samotní vývojári API. Napríklad API webovej stránky Odnoklassniki vracia kódy, ktorých popis nájdete na https://apiok.ru/wiki/pages/viewpage.action?pageId=77824003.

Okrem toho vám odporúčam vypočuť si pieseň Request Response - je to jednoduché a jasné o kódoch vrátených v HTTP požiadavkách (pozor, repchik :)).

REST API

REST API je ideológiou príspevku rojenie API, čo znamenáPrevod reprezentačného štátu API. Je založený na nasledujúcich princípoch formulovaných jeho tvorcom Autor: Roy Fielding:

1. Architektúra klient-server
2. Bezstavový server
3. Možnosť cache
4. Viacvrstvová štruktúra
5. Jednotné rozhranie
6. Kód na požiadanie

Nebudem zachádzať do podrobností, môžem poradiť tým, ktorí si chcú k téme prečítať

Máš psa. Ale ona nehovorí ľudskou rečou. Dokáže mu však „rozumieť“ cez povely, ktoré ju naučili počas výcviku. Ak poviete psovi, ktorý pozná povel "tenisky!" niečo ako "Rexic, dones mi, pzhalsta, moji tapuli so zajačikmi", možno len ucho zavedie k prezývke, ale papuče nedonesie. API je teda súbor príkazov, pomocou ktorých vám váš pes rozumie a robí, čo potrebujete. Toto je veľmi zjednodušené aj pre čajník, ale podstata je myslím jasná.

Rozhranie API je jazyk, regulovaný spôsob komunikácie jedného počítačového programu s druhým, aby mohli spoločne vykonávať spoločnú úlohu, keď jeden program vykonáva požiadavky pre iný. Application Programming Interface (API) - Rozhranie pre programovanie aplikácií.

Tu je primitívna analógia pre figuríny, ktoré sa zrodili z ruky.

Predstavte si 5 cudzincov hovoriacich rôznymi jazykmi, ktorí potrebujú pracovať a žiť spolu, povedzme v Rusku. Nikto z nich nevie jazyk toho druhého, zatiaľ čo na splnenie nejakej úlohy potrebujú jeden tím podľa rolí, napríklad sa navzájom nakŕmiť a diskutovať o chuti jedla v ruštine. Aby ste to dosiahli, musíte nakúpiť potraviny, pripraviť jedlo, pripraviť stôl a diskutovať o jedlách pri jedle. Aby si rozumeli a vedeli nájsť produkty vo vonkajšom svete, naučíme ich základnú sadu ruských slovíčok. Predstavme si, že máme:

1. Francúzsky

2. Španiel

4. Angličan

5. taliančina

Rozdeľme im úlohy na vykonávanie čiastkových úloh nasledovne

Nakupovanie potravín: francúzština a španielčina

Varenie: španielčina, nemčina a angličtina

Prestieranie: angličtina a taliančina

Jedlo a diskusia o chuti Jedlá: VŠETKY

Aby všetky tieto úlohy zvládli, naučíme každého súbor tých ruských slovíčok, ktoré im vo vzájomnej spolupráci a spolupráci s vonkajším prostredím umožnia splniť všetky tieto úlohy. Pozrite si obrázok nižšie.

Takže to je všetko. Skupina našich zahraničných priateľov je skupina počítačových programov ktorí potrebujú komunikovať medzi sebou a s vonkajším prostredím.

Jazyk a slová označujúce produkty a elementárne činnosti ktoré sa majú vyrábať toto je API- normy, podľa ktorých spolu naši zahraniční priatelia komunikujú v ruštine, aby splnili všetky zadané čiastkové úlohy.

API 1: Slová pre produkty a kde kúpiť
API 2: Slová pre jedlá a spôsoby varenia
API 3: Slová pre zariadenia a operácie s nimi
API 4: Slová pre chuť a hodnotenie jedla

Môže to byť zložitejšie, napríklad povedzme, že API 2 je turecké, API 3 je čínske, API 4 je hindské

Príklad pre figuríny:

1. Je tam zásuvka. Skrýva sa za tým obrovské množstvo techniky. Ale aby ste to mohli použiť, musíte mať zástrčku so vzdialenosťou medzi tyčami 3cm a zásuvka dá 220v. Toto je API obrovského systému výroby elektrickej energie.

2. A je tam žehlička. Má svoj zložitý systém práce. Aby však fungovala so zásuvkou, spĺňa požiadavky API - potrebujete zástrčku so vzdialenosťou 3 cm a čaká na odozvu 220 voltov.

A to je všetko. Tieto dva systémy sú nezávislé, obrovské a zložité. Ale API sa robí preto, aby bolo vzájomné prepojenie čo najjednoduchšie.

API je skratka pre aplikačné programovacie rozhranie. Ide o množinu funkcií, konštánt, tried a prípadne ďalších objektov na interakciu s určitou časťou programu.

Myslím, že najzrozumiteľnejšie bude opísať to na príklade. Povedzme, že niekto napísal kalkulačku, ktorú chcete použiť vo svojom programe. Túto kalkulačku treba nejako riešiť. Tieto metódy interakcie s kalkulačkou sa budú nazývať API. Môžu byť rôzne a bez ich popisu sa nedá nič robiť. Možno máte funkciu na zapísanie čísla do pamäte, inú na vykonanie akcie a tretiu na získanie výsledku. Alebo možno budete mať jednu funkciu, ktorá prenesie medzi nimi dve čísla a operačný kód a okamžite vráti odpoveď.

Takéto popisy sú ako stvorené na všetko. Operačný systém má API, je to súbor funkcií, pomocou ktorých sa vytvára program: nadviazať sieťové pripojenie, nakresliť okno, spracovať stlačenie tlačidla. Pre niektoré servery je API súborom funkcií, ktoré vykonáva. Prehliadač pristupuje na stránku wikipédie – používa API na to, aby vám na požiadanie vrátil odpoveď.

Začnime základmi: čo je API? Skratka znamená Application Programming Interface alebo Application Programming Interface. Zdá sa, že názov hovorí sám za seba, ale je lepšie zvážiť podrobnejšie vysvetlenie.

Ako už bolo spomenuté, API je predovšetkým rozhranie. Rozhranie, ktoré umožňuje vývojárom použiť hotové bloky na zostavenie aplikácie. V prípade vývoja mobilných aplikácií môže knižnica pre prácu s „inteligentnou domácnosťou“ fungovať ako API – všetky nuansy sú implementované v knižnici a vo svojom kóde sa odvolávate iba na toto API.

V prípade webových aplikácií dokáže API odosielať dáta v inom formáte ako je štandardný HTML, čo umožňuje pohodlné používanie pri písaní vlastných aplikácií. Verejné rozhrania API tretích strán najčastejšie poskytujú údaje v jednom z dvoch formátov: XML alebo JSON. V prípade, že sa rozhodnete pre svoju aplikáciu vytvoriť API, nezabúdajte, že JSON je oveľa stručnejší a čitateľnejší ako XML a služby, ktoré poskytujú prístup k údajom vo formáte XML, to druhé postupne vyraďujú.

API vo webových aplikáciách na príkladoch

Aplikácia – napríklad Github – má svoje vlastné API, ktoré môžu použiť iní vývojári. Ako to budú používať, závisí od možností, ktoré API poskytuje, a od toho, ako dobre funguje predstavivosť vývojárov. GitHub API umožňuje napríklad získať informácie o používateľovi, jeho avatarovi, čítačkách, úložiskách a mnoho ďalších užitočných a zaujímavých informácií.

Podobne môžete poslať požiadavku v akomkoľvek jazyku, vrátane Ruby. Odpoveďou na žiadosť budú približne tieto informácie:

("login": "Freika", "id": 3738638, "avatar_url": "https://avatars.githubusercontent.com/u/3738638?v=3", "gravatar_id": "", "url": "https://api.github.com/users/Freika", "html_url": "https://github.com/Freika", "followers_url": "https://api.github.com/users/Freika/followers", "following_url": "https://api.github.com/users/Freika/following(/other_user)", "gists_url": "https://api.github.com/users/Freika/gists(/gist_id)", "starred_url": "https://api.github.com/users/Freika/starred(/owner)(/repo)", "subscriptions_url": "https://api.github.com/users/Freika/subscriptions", "organizations_url": "https://api.github.com/users/Freika/orgs", "repos_url": "https://api.github.com/users/Freika/repos", "events_url": "https://api.github.com/users/Freika/events(/privacy)", "received_events_url": "https://api.github.com/users/Freika/received_events", "type": "Používateľ", "site_admin": false, "name": "Evgeniy", "company": "", "blog": "http://frey.su/", "location": " Barnaul "," email ":" "," prenajímateľný ": true," bio ": null," public_repos ": 39," public_gists ": 13," sledovateľov ": 15," nasledujúci ": 21," created_at ": "2013-03-01T13: 48: 52Z", "updated_at": "2014-12-15T13: 55: 03Z")

Ako môžete vidieť z bloku vyššie, odpoveď obsahuje prihlasovacie meno, avatar, odkaz na profil na stránke a v API, stav používateľa, počet verejných úložísk a ďalšie užitočné a zaujímavé informácie.

Samotné API nestačí

Vytvorenie kompletného API pre vašu aplikáciu je len polovica úspechu. Ako chcete získať prístup k API? Ako na to budú odkazovať vaši používatelia?

Prvá vec, ktorá vám príde na myseľ, je zvyčajná séria HTTP požiadaviek na získanie požadovaných informácií, a to je nesprávna odpoveď. Najzrejmejší spôsob v tomto prípade nie je najpohodlnejší a najjednoduchší. Oveľa rozumnejšie by bolo vytvorenie špeciálnej knižnice pre prácu s rozhraním, ktorá bude popisovať všetky potrebné spôsoby prijímania a odosielania informácií pomocou API.

Použime opäť Github ako príklad: na prácu s API tejto vynikajúcej služby (a jej rozhranie poskytuje najrozsiahlejšie možnosti) bolo vytvorených niekoľko knižníc v rôznych jazykoch, napríklad drahokam Octokit. V dokumentácii pre takéto knižnice (a drahokam zobrazený ako príklad) môže každý vývojár, ktorý má záujem, nájsť všetky potrebné spôsoby, ako získať informácie z GitHub a poslať ich späť cez rozhranie API služby.

Ak teda vytvárate svoje vlastné API, pomyslite si, že možno stojí za to venovať sa vytvoreniu rovnakých knižníc na prácu s nimi v najbežnejších jazykoch. A buďte pripravení, že pri určitej úrovni dopytu po vašej aplikácii si niekto iný môže vytvoriť vlastnú knižnicu na prácu s vaším API. Toto je fajn.

užitočné odkazy

V ďalších článkoch si povieme, ako správne vytvoriť API, zabezpečiť jeho bezpečnosť a obmedziť prístup k niektorým informáciám.