Läsare som du hjälper till att stödja MUO. När du gör ett köp med hjälp av länkar på vår webbplats kan vi tjäna en affiliate-provision. Läs mer.

En API-ändpunkt är en anslutningspunkt mellan två program. API: er har slutpunkter för varje resurs. Slutpunkterna anger den exakta platsen för en resurs på servern.

När en klientapplikation begär information från servern går den via API: et. Som sedan kommer åt begäran och bearbetar ett svar från servern. API: t överför sedan den begärda informationen från slutpunkten till applikationen.

Ditt API är effektivt om det kan kommunicera effektivt via sina slutpunkter. Det gör det lättare för användare att komma åt resurser, vilket förbättrar användarupplevelsen.

Hur fungerar en API-ändpunkt?

Integrerade system kommunicerar via API: er. Ett system skickar en begäran till API: t med hjälp av ett format som SOAP eller REST. Servern tar emot förfrågningarna och överför svaret tillbaka till API: et. Platsen för den begärda resursen är slutpunkten.

Innan en slutpunkt behandlar en begäran måste klienten tillhandahålla en URL, rubriker och en text. Rubrikerna innehåller metadata om en begäran och kroppsinformation som skickas till servern. En server kan också ansluta till en databas som

instagram viewer
API-metoder kan komma åt.

API-slutpunkter fungerar vanligtvis med HTTP-metoder som GET, DELETE, PATCH eller POST. Metoderna avgör hur en endpoint ska användas. När en klient skickar en förfrågan måste den formuleras så att den inkluderar förfrågningsmetoden såväl som URL: en, till exempel:

SKAFFA SIG https://example.com/books/authors

Namngivning är svårt, oavsett om det är API-slutpunkter, nätverksanslutna hårdvaruenheter, eller funktioner och variabler. Du bör lära dig om några bästa metoder som du kan använda för att säkerställa att dina API-slutpunkter är en tillgång.

1. Använd ett snedstreck framåt

Använd alltid snedstreck för att separera URI-resurser. Snedstreck hjälper också till att visa resurshierarki. Följande är ett exempel:

https://example.com/books/authors

2. Använd substantiv, inte verb

Du bör bara använda substantiv för att namnge en resurs. Substantiv beskriver vad en resurs är till för i motsats till ett verb som beskriver vad en resurs gör. Här är ett exempel på ett bra och ett dåligt sätt att namnge API-slutpunkter.

Bra namn:

https://example.com/api/getBooks

Dåligt namn:

http://example.com/api/books

3. Använd plural substantiv, inte singular

Du bör alltid namnge dina API-slutpunkter i substantiv i plural. Detta indikerar för en användare att det finns mer än en resurs på servern. Att använda ett singulär substantiv kan förvirra användaren till att tro att det bara finns en resurs.

Bra namn:

https://example.com/api/book/3

Dåligt namn:

http://example.com/api/books/3

4. Använd små bokstäver

Du bör skriva alla webbadresser med gemener. Detta inkluderar API-slutpunktsadresser. Här är ett exempel:

Bra namn:

http://example.com/api/Books/3

Dåligt namn:

http://example.com/api/books/3

5. Använd bindestreck för att skilja ord åt

Använd bindestreck för att separera kombinerade ord. Bindestreck resulterar i mer läsbara fraser än kamelfall eller understreck. De är också bättre för SEO-ändamål.

Bra namn:

https://example.com/api/books/33/front_cover

Dåligt namn:

https://example.com/api/books/33/front-cover

6. Lägg inte till filtillägg

Du behöver inte lägga till ett filtillägg till dina API-slutpunkter. Även om det inte påverkar utdata, gör en tillägg det svårare att läsa resursen. Det gör också resursen mindre flexibel och bryter den om förlängningen ändras i framtiden.

Bra namn:

https://example.com/api/books.xml

Dåligt namn:

https://example.com/api/books

7. Inkludera versionshantering

Du bör alltid namnge dina API-slutpunkter enligt versionen. Detta är viktigt om du gör stora ändringar i API: et. Det hjälper till att skilja mellan två eller flera API-versioner där resursen kommer ifrån. Du kan ange versionen i början av slutpunkten.

Till exempel:

https://example.com/api/v3/books

Varför överväga API Best Practices?

API: er har blivit ryggraden i modern programmering. De förbättrar samarbetet, uppmuntrar innovation och förbättrar applikationssäkerheten.

Oavsett om du använder nya verktyg eller hanterar befintliga, förenklar API: er processen. Så det är viktigt att ha slutpunkter som förbättrar användarupplevelsen. Namnet och strukturen för dina API-slutpunkter bestämmer prestandan för ditt API.

Se till att du använder bästa praxis för att skapa effektiva API-slutpunkter.