Perusteelliset käytännön oppaat

Kysy julkista APIa ja säilytä todennettava poiminta

Määritä kysely, sivutus, virheet ja raakavastaus ennen tiedon muuntamista.

Päivitetty :

Valokuitukytkentäpaneeli, Patrick Finneganin kuva vuodelta 2002.

Valokuitukytkentäpaneeli, Patrick Finneganin kuva vuodelta 2002. Dokumentaarinen taustakuva; se ei esitä Alexis Roux ZG:n toimeksiantoa tai laitteistoa. © Patrick Finnegan · Lähde · CC BY 2.0. Kokoa muutettu ja muunnettu WebP-muotoon; rajattu näyttö.

Miten poiminta toistetaan liioittelematta kattavuutta?

API vastaa kyselyyn tietyllä rakenteella ja hetkellä. Se ei osoita koko tietokannan kysymistä tai muuttumattomuutta kutsujen välillä. Erota keruun kirjaus analyysistä.

  1. Valitse pääsy

    Lue viralliset ohjeet: versio, rajaus, ehdot, tunnistautuminen ja rajat. Koko tietokantaa varten etsi virallinen vienti.

  2. Aloita pienestä

    Kirjaa endpoint, menetelmä, parametrit, suodatus ja järjestys. Suosi tunnisteita äläkä julkaise avaimia tai tokeneita.

  3. Tarkista vastaus

    Säilytä HTTP-tila, aika, muoto ja virheet. Tarkista kentät ja yksiköt; HTTP 200 voi sisältää tyhjän vastauksen tai toimintavirheen.

  4. Seuraa sivutusta

    Tutki kokonaismäärä, sivut ja kursorit. Laske rivit sekä yksilölliset tunnisteet, kirjaa toistot ja pysäytysehto. Tietokanta voi muuttua keruun aikana.

  5. Säilytä alkuperäinen

    Pidä raakavastaus ja tiiviste; dokumentoi siivous ja muunnokset. Älä julkaise henkilötietoja tai salaisuuksia avoimessa lokissa.

  6. Käsittele muutos

    Noudata uusintapyyntöjen ohjeita 429-tilassa tai katkossa. Uusi poiminta on uusi havainto; vertaa myös rakennetta ja rajausta.

Pienet kyselyesimerkit

Osoitteet näyttävät syntaksin. Tarkista saatavuus, tunnistautuminen ja ehdot dokumentaatiosta.

Tilanteet ja päätökset

Tyypillisiä tilanteita tarkistuksen suunnitteluun. Ne eivät kuvaa toteutettuja toimeksiantoja tai todellisia havaintoja.

Vain yksi sivu

Tarkista kokonaismäärä ja seuraava kursori ennen kattavan luvun julkaisemista.

Puuttuva muutettiin nollaksi

Erota null, puuttuva kenttä, tyhjä lista ja nolla; ne vaikuttavat keskiarvoon.

Sama kysely, uudet luvut

Eurostat kuvaa uusimpien versioiden tietokannan. Säilytä päivätty poiminta vanhojen laskujen toistamiseksi.

Säilytettävä näyttö

  • Palvelu, versio ja salaisuudettomat parametrit.
  • Aika, tila, muoto, sivut ja pysäytys.
  • Raakavastaus, tunnisteet ja tiiviste.
  • Muunnokset, yksiköt ja rajoitukset.

Viralliset lähteet

Liittyvät lähdesivut

Aiheeseen liittyvät protokollat

Tarkistukset ennen johtopäätöstä

  • Voiko valinnan toistaa ilman salaisuutta?
  • Huomioiko luku sivut ja toistot?
  • Erottuvatko raakavastaukset siivotusta tiedosta?

Usein kysytyt kysymykset

Osoittaako HTTP 200 kattavuuden?

Ei. Tarkista sisältö, suodatus, kokonaismäärä ja sivutus.

Pitääkö kerätä koko tietokanta?

Ei. Valitse hyödyllinen rajaus ja dokumentoi se.

Takaako tiiviste luvut?

Se vertaa säilytettyjä tavuja. Menetelmä ja laatu vaativat omat tarkistuksensa.