Kaltaisesi lukijat auttavat tukemaan MUO: ta. Kun teet ostoksen käyttämällä sivustollamme olevia linkkejä, voimme ansaita kumppanipalkkion. Lue lisää.

API-päätepiste on yhteyspiste kahden ohjelmiston välillä. API: illa on päätepisteet jokaiselle resurssille. Päätepisteet määrittävät resurssin tarkan sijainnin palvelimella.

Kun asiakassovellus pyytää tietoja palvelimelta, se kulkee API: n kautta. Joka sitten käyttää pyyntöä ja käsittelee vastauksen palvelimelta. Tämän jälkeen API siirtää pyydetyt tiedot päätepisteestä sovellukseen.

API on tehokas, jos se voi kommunikoida tehokkaasti päätepisteidensä kautta. Se helpottaa käyttäjien pääsyä resursseihin ja parantaa käyttökokemusta.

Kuinka API-päätepiste toimii?

Integroidut järjestelmät kommunikoivat API: iden kautta. Yksi järjestelmä lähettää pyynnön API: lle käyttämällä muodossa, kuten SOAP tai REST. Palvelin vastaanottaa pyynnöt ja siirtää vastaukset takaisin API: lle. Pyydetyn resurssin sijainti on päätepiste.

Ennen kuin päätepiste käsittelee pyynnön, asiakkaan on annettava URL-osoite, otsikot ja teksti. Otsikot sisältävät pyynnön metatiedot ja palvelimelle lähetetyt runkotiedot. Palvelin voi myös muodostaa yhteyden tietokantaan, joka

API-menetelmät pääsee käsiksi.

API-päätepisteet toimivat yleensä HTTP-menetelmien, kuten GET, DELETE, PATCH tai POST, kanssa. Menetelmät määrittävät, kuinka päätepistettä käytetään. Kun asiakas lähettää pyynnön, sen on muotoiltava se sisältämään pyyntömenetelmä sekä URL-osoite, esimerkiksi:

SAADA https://example.com/books/authors

Nimeäminen on vaikeaa, olipa kyse API-päätepisteistä, verkkoon liitetyt laitteistottai funktioita ja muuttujia. Sinun tulisi oppia joistakin parhaista käytännöistä, joiden avulla voit varmistaa, että API-päätepisteet ovat hyödyllisiä.

1. Käytä kenoviivaa

Käytä aina vinoviivaa URI-resurssien erottamiseen. Vinoviivat auttavat myös näyttämään resurssien hierarkian. Seuraava on esimerkki:

https://example.com/books/authors

2. Käytä substantiiveja, ei verbejä

Käytä vain substantiivia resurssin nimeämiseen. Substantiivit kuvaavat, mitä varten resurssi on tarkoitettu, toisin kuin verbi, joka kuvaa resurssin toimintaa. Tässä on esimerkki hyvästä ja huonosta tavasta nimetä API-päätepisteet.

Hyvä nimitys:

https://example.com/api/getBooks

Huono nimitys:

http://example.com/api/books

3. Käytä monikkosubstantiivit, ei yksikköä

Sinun tulee aina nimetä API-päätepisteesi monikossa. Tämä osoittaa käyttäjälle, että palvelimella on useampi kuin yksi resurssi. Yksikkösubstantiivin käyttö saattaa hämmentää käyttäjää ajattelemaan, että resursseja on vain yksi.

Hyvä nimitys:

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

Huono nimitys:

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

4. Käytä pieniä kirjaimia

Sinun tulee kirjoittaa kaikki URL-osoitteet pienillä kirjaimilla. Tämä sisältää API-päätepisteiden URL-osoitteet. Tässä on esimerkki:

Hyvä nimitys:

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

Huono nimitys:

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

5. Käytä väliviivoja sanojen erottamiseen

Käytä yhdysviivoja erottaaksesi yhdistetyt sanat. Tavuviivat johtavat luettavampiin lauseisiin kuin kamelin kirjain tai alaviivat. Ne ovat myös parempia SEO-tarkoituksiin.

Hyvä nimitys:

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

Huono nimitys:

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

6. Älä lisää tiedostopäätteitä

Sinun ei tarvitse lisätä tiedostopäätettä API-päätepisteisiisi. Vaikka se ei vaikuta ulostuloon, laajennus vaikeuttaa resurssin lukemista. Se myös tekee resurssista vähemmän joustavaa ja rikkoo sen, jos laajennus muuttuu tulevaisuudessa.

Hyvä nimitys:

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

Huono nimitys:

https://example.com/api/books

7. Sisällytä versiointi

Sinun tulee aina nimetä API-päätepisteesi version mukaan. Tämä on tärkeää, jos teet suuria muutoksia sovellusliittymään. Se auttaa erottamaan kaksi tai useampia API-versioita, joista resurssi on peräisin. Voit ilmoittaa version päätepisteen alussa.

Esimerkiksi:

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

Miksi harkita API parhaita käytäntöjä?

API: sta on tullut nykyaikaisen ohjelmoinnin selkäranka. Ne parantavat yhteistyötä, kannustavat innovaatioita ja parantavat sovellusten turvallisuutta.

Sovellusliittymät yksinkertaistavat prosessia, käytettiinpä sitten uusia työkaluja tai hallitaan olemassa olevia. Joten on välttämätöntä, että sinulla on päätepisteitä, jotka parantavat käyttökokemusta. API-päätepisteiden nimeäminen ja rakenne määräävät API: n suorituskyvyn.

Varmista, että käytät parhaita käytäntöjä tehokkaiden API-päätepisteiden luomiseen.