Mikä on Web API?

Web API (tai Browser API) on kokoelma moderneihin verkkoselaimiin sisäänrakennettuja rajapintoja, joiden avulla JavaScript voi olla vuorovaikutuksessa selaimen ominaisuuksien, laitteiston ja käyttöjärjestelmän kanssa. Esimerkkejä ovat Fetch API verkkopyyntöjä varten, Geolocation API GPS-koordinaatteja varten, WebGL 3D-grafiikkaa varten, Clipboard API kopiointi/liittämistä varten ja satoja muita. Jokainen API määritellään web-standardeja asettavien organisaatioiden, kuten W3C ja WHATWG, toimesta, ja selainvalmistajat toteuttavat ne omalla aikataulullaan.

Koska selaintuki vaihtelee suuresti — jotkut API:t ovat yleisesti tuettuja, toiset ovat kokeellisia tai valmistajakohtaisia — kehittäjien on usein tarkistettava, mitkä API:t ovat todella saatavilla tietyssä selaimessa ennen niiden käyttöä. Ominaisuuksien tunnistaminen (tarkistaminen, onko API olemassa window-objektissa ennen sen kutsumista) on vakiintuneet lähestymistapa.

Työkalun kuvaus

Tämä työkalu testaa, mitkä Web API:t ovat saatavilla nykyisessä selaimessasi reaaliajassa. Se yhdistää live-selaimen tunnistamisen MDN:n selaimen yhteensopivuustietoihin, jotta saat kattavan näkemyksen siitä, mitkä API:t ovat tuettuja, missä versiossa ne tulivat saataville ja ovatko ne vielä kokeellisia.

Ominaisuudet

  • Live-tunnistaminen: Testaa jokaisen API:n selaimesi todellista window-objektia vastaan ja raportoi tuetun, ei-tuetun tai tuntemattoman tilan välittömästi
  • MDN-yhteensopivuustiedot: Näyttää Chrome-, Firefox-, Safari- ja Edge-selaimen vähimmäisversion, joka tukee jokaista API:ta, lähteenä virallinen @mdn/browser-compat-data-paketti
  • Kokeellisten API:en merkitseminen: Merkitsee selvästi API:t, jotka ovat vielä kokeellisia tai ominaisuuslippujen takana
  • Mukautetun lausekkeen testaustyökalu: Kirjoita mikä tahansa JavaScript-lauseke testataksesi sitä live-tilassa selaimessasi ja nähdäksesi tuloksen tai virheen
  • Suodatus ja haku: Suodata tuen tilan (tuettu/ei tuettu/tuntematon) perusteella ja etsi API-nimen perusteella löytääksesi tarvitsemasi nopeasti

Kuinka se toimii

Työkalu lataa Web API -merkintöjen luettelon MDN Browser Compat Data -paketista rakennusaikana. Kun avaat sivun, se arvioi jokaisen API-nimen globaalin window-objektin ominaisuutena — jos ominaisuus on olemassa ja ei ole nolla, API merkitään tuetuksi. MDN-versiotiedot on esikuormitettu ja näytetään live-tunnistamisen tuloksen rinnalla.

Vinkkejä

  • Käytä tilan suodatinta näyttääksesi vain selaimessasi tuettuja API:ta — hyödyllinen tarkistettaessa, mitä on saatavilla ennen koodin kirjoittamista.
  • Käytä mukautetun lausekkeen kenttää monimutkaisempien ominaisuuksien tarkistamiseen, kuten typeof navigator.bluetooth !== 'undefined' tai 'serviceWorker' in navigator.
  • Kokeelliset API:t saattavat olla saatavilla joissakin selainversioissa, mutta eivät vakaissa julkaisuissa — tarkista aina MDN-dokumentaatio ennen niiden käyttöä tuotannossa.