API-d kujundavad üha enam tehnilist ökosüsteemi. Peaaegu kõigil kaasaegsetel rakendustel on nüüd API lõpp-punkt, millega saate suhelda.
API-d töötavad vahendajatena, võimaldades teil luua programmilisi suhtlusi rakenduste vahel, mida inimesed ja ettevõtted igapäevaselt kasutavad.
Kuid mitte kõik API-d ei sobi integreerimiseks ja kasutamiseks. On olemas kohutavad API-d, mis kasutajaid frustreerivad. Järgmine on juhis, mille abil saate tuvastada teie arendusvajadustele vastava API.
1. Optimeeritud API kõneaeg
Optimeerimine API kõned hõlmab API reageerimisaja vähendamist. See hõlmab seda, kui kiiresti API päringuid teenindab ja vastuseid saadab. See hõlmab ka suure andmemahu mõju vähendamist API kiirusele.
API reageerimisaeg mõjutab kasutajakogemust. Aeglased API-d häirivad kasutajat ja mõjutavad rakenduse jõudlust. Suure jõudlusega API reageerimisaeg peaks olema alla ühe sekundi.
Arendajana saate testida mis tahes kasutatava API kiirust Chrome DevTools. Ava Arendaja tööriistad > Võrk, seejärel avage oma brauseris API lõpp-punkt.
Näete API toimivuse jaotust oleku, tüübi, suuruse ja aja alusel. Aeg mõõdab API kiirust.
Saate minna kaugemale ja analüüsida API komponente samal vahekaardil. Klõpsake lõpp-punktil. Näete avatud vahekaarti, mis sisaldab teavet selle komponentide kohta. Need hõlmavad üksikasju selle kohta Päised, Vastusja Ajastus.
Nüüd saate aru, kas API on teie rakenduse jaoks piisavalt kiire. Saate kasutada ka teisi võrgutööriistu testige API kiirust. Arendajate seas populaarsed on Postimees ja Swagger.
2. Sisaldab sisseelamisjuhendeid
Hea API pakub kasutajatele sisseelamisjuhiseid. Sissevõtmise juhend peaks teid API sisuga kurssi viima. See selgitab API kasutusjuhtumeid ja nende integreerimist. Teave võib sisaldada selle lõpp-punkti määratlusi, koodilõike ja näidisvastuseid.
RapidAPI sissetöötamise juhend on hea näide. Juhendis on kõik, mida kasutajad API-de tarbimiseks teadma peavad.
Sissevõtmise juhendid peaksid sisaldama ka autentimisteavet. On oluline, et teil oleks hästi dokumenteeritud autentimisprotsess, et saaksite hõlpsasti API-ga töötama hakata.
API-d kasutavad kasutajate autentimiseks erinevaid viise. Kõige tavalisem on API-võtme kasutamine. Iga registreeritud kasutaja saab API-võtme, mida ta kasutab kõnede tegemiseks. API-l võivad erinevate kasutajakategooriate jaoks olla erinevad autentimisvõtmed.
3. Sellel on selge ja lühike dokumentatsioon
Kogu tehniline sisu peaks olema selge ja lühike. Selgus on API-de jaoks eriti oluline. Arendajana ei ole teil aega liiga palju dokumentatsiooni läbi tuhnida, seega otsige API-sid, mis hõlbustavad nende kasutamise õppimist.
Dokumentatsioon tagab kasutajatele hea kasutuskogemuse. Kogemused on API kasutuselevõtu suurendamiseks üliolulised. Hästi struktureeritud dokumentatsioon kirjeldab lõpp-punkte, meetodeid ja vastusevalikuid.
Hea dokumentatsioon peab kasutajaid silmas. Need on inimesed, kes API-st ei tea. Seetõttu tuleks kogu teabes kasutada tuttavaid sõnu ja väljendeid.
Dokumentatsioon peaks sisaldama samm-sammult näiteid ja illustratsioone. Need aitavad teil mõistetest kiiresti aru saada. Allpool on näide hästi struktureeritud dokumentatsioonist Twilio veebisait.
API dokumentatsioon peaks järgima rangeid juhiseid. Hea näide API dokumentatsiooni juhendist on Tom Johnsoni oma Ma pigem kirjutan giid. See on täielik juhend API dokumentatsiooni struktureerimise ja kirjutamise kohta.
4. Sellel on interaktiivne konsool
Heal API-l on konsool, kus saate API-d testida. API lõpp-punktide testimine võimaldab teil näha, kas see vastab teie nõuetele.
Interaktiivsed konsoolid loovad mänguväljaku, kus saate lõpp-punkte kiiresti testida. See on eelis, kuna see tähendab, et te ei pea kasutama muid testimisvahendeid. Konsoolid on hea viis kindlaks teha, kas API vastab teie arendusvajadustele.
RapidAPI veebisaidil on hea näide interaktiivsest konsoolist, mida saate API kasutusjuhtude testimiseks kasutada.
5. Pakub kasutusvõimalusi
API dokumentatsioon peaks selgelt näitama, kas see on tasuta või mitte. Peate teadma, millised plaanid on tasuta ja millised nõuavad tasumist. Vältige keerulisi ja paljude piirangutega hinnaplaane.
Headel API-del on erinevate klientide jaoks mitu plaani. Teave iga plaaniga kaasnevate kasutuskvootide ja piirangute kohta peaks olema avatud. RapidAPI on selge hinnaplaan, mis sisaldab põhilisi tasuta ja tasulisi ettevõtte plaane oma kasutajatele.
6. Seal on juhendid ja õpetused
Õpetused aitavad kasutajatel mõista, kuidas API töötab. Nad õpetavad algajale API-t praktiliselt kasutama. Seda järgides peaksite mõistma, mida API-ga suhtlemisel oodata.
Õpetuse eesmärk on aidata teil luua süsteemiga võimalikult lihtne väljund. API õpetus võib olla vastus API-s tehtud päringule. See näitab, kuidas kasutada keelt või raamistikku teatud vastuse saamiseks.
Õpetused peaksid sisaldama juhiseid konto registreerimiseks ja genereerida API võtmeid. Lisaks peaksid olema juhised päringu saatmise ja vastuse kontrollimise kohta. Hea juhend sisaldab ka illustratsioone, nagu diagrammid, infograafika ja audiovisuaal. Need hõlbustavad protsesside mõistmist.
Heade illustratsioonidega API näide on AsyncAPI algatus.
Eelduseks on, et kui helistate ühel kasutusjuhul õpetuse abil, õnnestub teil teha ka teisi kõnesid. Hea mõte on kontrollida, kas õpetused on õiged.
Miks peaksite seda API juhist kasutama?
API-d loovad võimalusi suhelda rakendustega üle kogu maailma. Hea funktsiooni tuvastamine säästab aega, mille oleksite kulutanud funktsiooni nullist loomisele.
API-d annavad teile juurdepääsu hämmastavate funktsioonidega maailmatasemel rakendustele. Hea API saamiseks peate arvestama API aspektidega, mis lähevad kaugemale lõpp-punktidest ja kõnemeetoditest.
Hea API on kiire ja hästi dokumenteeritud, et inspireerida arendajaid sellega suhtlema. Järgige ülaltoodud juhiseid ja valige oma rakenduse jaoks parim API.
