API design principer

Vad är ett API?

Ett API (Application Programming Interface) är en uppsättning regler som låter olika program kommunicera med varandra.

Vad står REST för?

REST står för Representational State Transfer. Det är en stil för att skapa webb-API:er som är lättanvända och skalbara.

Sann eller falsk: API:er bör vara stateless.

Sann. Stateless innebär att varje begäran från klienten till servern måste innehålla all information för att förstå begäran.

Jämför REST och SOAP.

REST är lättvikts och använder HTTP, medan SOAP är mer strukturerad och kräver XML. REST är enklare för webben.

Fyll i det tomma: API:er bör vara ____.

API:er bör vara konsistenta. Konsistens gör dem lättare att använda och förstå för utvecklare.

Vad är en endpoint?

En endpoint är en specifik URL där en API-resurs kan nås och interageras med. Exempel: /users/123.

Vilken HTTP-metod används för att skapa resurser?

POST används för att skapa nya resurser i ett API.

Vad är en statuskod?

Statuskoder är svar från servern som indikerar resultatet av en API-begäran. Exempel: 200 (OK), 404 (Not Found).

Vad gör en API-versionering?

API-versionering tillåter utvecklare att göra ändringar utan att bryta befintliga klienter. Det kan göras genom URL- eller header-versionering.

Vad innebär idempotens?

Idempotens betyder att upprepade begärningar av samma operation ger samma resultat utan att påverka systemets tillstånd.

Ange ett fördel med API:er.

API:er möjliggör integration mellan olika system och tjänster, vilket främjar återanvändning av kod och resurser.

Vad är JSON?

JSON (JavaScript Object Notation) är ett lättviktigt dataformat som används för att utbyta data mellan klienter och servrar.

Sann eller falsk: API:er bör dokumenteras.

Sann. Bra dokumentation underlättar för utvecklare att förstå hur man använder API:et effektivt.

Vad är CORS?

CORS (Cross-Origin Resource Sharing) är en säkerhetsfunktion som tillåter eller hindrar resurser från att begäras från en annan domän.

Vad innebär throttling?

Throttling begränsar antalet API-begärningar som en användare kan göra under en viss tid för att skydda servern.

Vad är en payload?

Payload är den data som skickas med en API-begäran eller svar. Exempel: JSON-objekt i en POST-begäran.

Vad är ett designmönster?

Ett designmönster är en generell lösning på ett återkommande problem inom programvarudesign, som kan återanvändas i olika sammanhang.

Singleton-mönstret

Säkerställer att en klass har en enda instans och ger en global åtkomstpunkt. Används exempelvis för resursstyrning.

Fördelar med API-versionering?

Möjliggör bakåtkompatibilitet, gör det enkelt att hantera förändringar och förbättrar användarupplevelsen.

Vad är MVC-mönstret?

Model-View-Controller (MVC) separerar applikationens data (modell), användargränssnitt (vy) och logik (kontroller).

Observer-mönstret

Ett mönster där objekt (observatörer) registrerar sig för att ta emot uppdateringar från ett annat objekt (subjekt).

Är Factory-mönstret alltid statiskt?

Falskt. Factory-mönstret kan vara både statiskt och dynamiskt beroende på implementation och behov.

Vad är REST?

Representational State Transfer (REST) är en stil för att bygga webb-API:er som använder HTTP-protokollet.

Strategi-mönstret

Definierar en familj av algoritmer, kapslar in dem och gör dem utbytbara. Används för att variera beteenden.

Vad gör Adapter-mönstret?

Adapter-mönstret gör att inkompatibla gränssnitt kan fungera tillsammans genom att 'anpassa' ett gränssnitt till ett annat.

Observera skillnaden mellan API och SDK.

API:er tillhandahåller funktionalitet, medan SDK:er erbjuder verktyg för att använda API:er effektivt.

Vad är Command-mönstret?

Kapslar in en begäran som ett objekt, vilket möjliggör parametrisering av klienter med olika begärningar.

True or False: API:er ska alltid vara versionerade.

Sant. Versionering skyddar användare från brutna förändringar och säkerställer stabilitet.

Vad innebär Liskov Substitution Principle?

Det innebär att objekt av en underklass ska kunna ersätta objekt av en överklass utan att påverka programmet negativt.

Vad är Composite-mönstret?

Composite-mönstret tillåter att grupper av objekt hanteras på samma sätt som enskilda objekt, vilket förenklar hantering av hierarkier.

Vad är en API-gateway?

En API-gateway fungerar som en ingångspunkt för API-anrop, hanterar autentisering, routing och protokollkonvertering.

Vad gör Decorator-mönstret?

Decorator-mönstret tillåter att lägga till funktionalitet till objekt dynamiskt utan att förändra deras struktur.

Vad är syftet med API-dokumentation?

Att förklara hur API:et används och underlätta för utvecklare att integrera.

Sant eller falskt: Bra dokumentation ökar användbarheten.

Sant. Tydlig dokumentation minskar inlärningstiden för användare.

Vilka komponenter ingår i API-dokumentation?

- Introduktion - Autentisering - Exempel - Felhantering - API-specifikationer

Vad ska inkluderas i ett API-exempel?

Exempel på begärningar och svar, inklusive parametrar och förväntade resultat.

Vad är en bra praxis för API-dokumentation?

Att använda tydliga rubriker och avsnitt för att organisera information.

Fyll i blank: Dokumentation bör vara ______ och ______.

klarspråkig och omfattande.

Jämför två dokumentationsformat: Markdown vs HTML.

Markdown är enklare och snabbare att skriva, medan HTML erbjuder mer stil och struktur.

Hur kan interaktiv dokumentation hjälpa användare?

Den låter användare göra testanrop direkt i dokumentet, vilket förbättrar förståelsen.

Vilken roll spelar exempel i dokumentationen?

De visar hur API:et används i praktiken och hjälper till att förtydliga funktionalitet.

Vad är ett vanligt verktyg för API-dokumentation?

Swagger, som erbjuder både dokumentation och interaktivitet.

Hur påverkar bristande dokumentation API-använding?

Det kan leda till frustration och felanvändning, vilket minskar effektiviteten.

Sant eller falskt: Användarfeedback kan förbättra dokumentation.

Sant. Feedback ger insikter om områden som behöver förbättras.

Vad är viktigt att ange i felhantering?

- Felkoder - Beskrivningar av fel - Förslag på lösningar

Vad är syftet med versionshantering i dokumentation?

Att hålla reda på förändringar och säkerställa att användare har korrekt information.

Ge ett exempel på en bra dokumentationsstruktur.

1. Introduktion 2. Autentisering 3. Endpoints 4. Exempel 5. Felhantering

Vilka språk används ofta för API-dokumentation?

JavaScript, Python, och Ruby är vanliga för kodexempel och skript.