API'er former i stigende grad det teknologiske økosystem. Næsten alle moderne applikationer har nu et API-endepunkt, som du kan interagere med.
API'er fungerer som mellemled, hvilket giver dig mulighed for at opbygge programmatiske interaktioner mellem applikationer, som mennesker og virksomheder bruger dagligt.
Det er dog ikke alle API'er, der er egnede til integration og brug. Der findes frygtelige API'er, der frustrerer brugere. Det følgende er en guideline, du kan bruge til at identificere en API, der passer til dine udviklingsbehov.
1. Optimeret API-opkaldstid
Optimering API-kald involverer at reducere responstiden for en API. Dette inkluderer, hvor hurtigt API'en betjener anmodninger og sender svar. Det involverer også at reducere den effekt, som store mængder data har på API-hastigheden.
En API-svartid påvirker brugeroplevelsen. Langsomme API'er frustrerer brugeren og påvirker applikationens ydeevne. En højtydende API bør have en responstid på mindre end et sekund.
Som udvikler kan du teste hastigheden af enhver API ved hjælp af Chrome DevTools. Åbn Udviklerværktøjer > Netværk, og få derefter adgang til API-slutpunktet i din browser.
Du vil se en opdeling af API-ydeevnen baseret på status, type, størrelse og tid. Tiden måler API'ets hastighed.
Du kan gå videre og analysere API-komponenterne på samme fane. Klik på slutpunktet. Du vil se en fane åben med oplysninger om dens komponenter. Disse omfatter detaljer om Overskrifter, Respons, og Timing.
Du kan nu se, om API'en er hurtig nok til din applikation. Der er andre online værktøjer, du kan bruge til test for API-hastighed. De populære blandt udviklere er Postbud og Swagger.
2. Har Onboarding Guides
En god API giver onboarding retningslinjer for brugere. Onboarding-guiden skal gøre dig bekendt med indholdet af API'en. Den forklarer API'ens use cases og hvordan man integrerer dem. Oplysningerne kan omfatte dets slutpunktsdefinitioner, kodestykker og eksempelsvar.
RapidAPI's onboarding guide er et godt eksempel. Guiden har alt, hvad brugerne behøver at vide for at bruge deres API'er.
Onboarding-vejledninger bør også indeholde autentificeringsoplysninger. Det er vigtigt at have en veldokumenteret autentificeringsproces, så du nemt kan begynde at arbejde med API'en.
API'er bruger forskellige måder at autentificere deres brugere på. Det mest almindelige er at bruge en API-nøgle. Hver registreret bruger får en API-nøgle, som de bruger til at foretage opkald. API'et kan have forskellige godkendelsesnøgler for forskellige kategorier af brugere.
3. Har klar og præcis dokumentation
Alt teknisk indhold skal være klart og kortfattet. Klarhed er især vigtig for API'er. Som udvikler har du ikke tid til at vade for meget dokumentation, så kig efter API'er, der gør det nemt at lære at bruge dem.
Dokumentation sikrer, at brugerne får en god brugeroplevelse. Erfaring er afgørende for at øge adoptionen af API. Velstruktureret dokumentation beskriver endepunkter, metoder og svarmuligheder.
God dokumentation har brugerne i tankerne. Det er folk uden kendskab til API'en. Derfor bør alle oplysninger bruge velkendte ord og vendinger.
Dokumentationen skal indeholde trinvise eksempler og illustrationer. Disse hjælper dig med at forstå begreberne hurtigt. Nedenfor er et eksempel på velstruktureret dokumentation fra Twilio hjemmeside.
En API's dokumentation bør følge stærke retningslinjer. Et godt eksempel på en API-dokumentationsvejledning er Tom Johnsons Jeg vil hellere skrive guide. Det er en komplet guide til, hvordan man strukturerer og skriver API-dokumentation.
4. Har en interaktiv konsol
En god API har en konsol, hvor du kan teste API'en. Test af en API's slutpunkter giver dig mulighed for at se, om den passer til dine krav.
Interaktive konsoller skaber en legeplads, hvor du kan teste slutpunkterne hurtigt. Dette er en fordel, da det betyder, at du ikke behøver at bruge andre testværktøjer. Konsoller er en god måde at afgøre, om API'en passer til dine udviklingsbehov.
RapidAPI-webstedet har et godt eksempel på en interaktiv konsol, du kan bruge til at teste API-brugssager.
5. Giver brugsmuligheder
API-dokumentation skal gøre det klart, om det er gratis eller ej. Du skal være opmærksom på, hvilke planer der er gratis, og hvilke der kræver betaling. Undgå komplicerede prisplaner og dem med mange begrænsninger.
Gode API'er har flere planer for at imødekomme forskellige kunder. Oplysninger bør være åbne om brugskvoter og begrænsninger, der følger med hver plan. RapidAPI har en klar prisplan, der inkluderer grundlæggende gratis og betalte firmaplaner for sine brugere.
6. Har vejledninger og tutorials
Selvstudier hjælper brugere med at forstå, hvordan en API fungerer. De lærer en nybegynder at bruge API'et praktisk. Ved at følge en, bør du forstå, hvad du kan forvente, når du interagerer med API'en.
Målet med en tutorial er at guide dig til at producere det enklest mulige output med systemet. En API-tutorial kan være et svar på en anmodning lavet på API'et. Den viser dig, hvordan du bruger et sprog eller en ramme for at få en bestemt respons.
Selvstudier bør indeholde instruktioner om, hvordan du tilmelder dig en konto og generere API-nøgler. Derudover bør der være instruktioner om, hvordan du sender en anmodning og kontrollerer svaret. En god tutorial vil også have illustrationer såsom diagrammer, infografik og audiovisuelle billeder. Disse gør det lettere at forstå de involverede processer.
Et eksempel på en API med gode illustrationer er AsyncAPI Initiative.
Antagelsen er, at hvis du foretager et opkald på én use case ved hjælp af en tutorial, vil det lykkes dig at foretage andre opkald. Det er en god idé at tjekke, om tutorials er korrekte.
Hvorfor du bør bruge denne API-retningslinje
API'er skaber muligheder for at interagere med applikationer over hele verden. At identificere en god vil spare den tid, du ville have brugt på at oprette en funktion fra bunden.
API'er giver dig adgang til applikationer i verdensklasse med fantastiske funktioner. For at få en god API skal du overveje aspekter af API'en, der rækker ud over endepunkterne og opkaldsmetoderne.
En god API er hurtig og veldokumenteret for at inspirere udviklere til at interagere med den. Følg ovenstående retningslinjer og vælg den bedste API til din applikation.