Rakenna ja määritä työkalu

Aloita yrityspalvelun virallisesta API-dokumentaatiosta ja tehtävästä, jonka tilisi saa suorittaa. Yksi kapea, hyvin kuvattu työkalu on helpompi testata kuin yleinen työkalu, joka hyväksyy mielivaltaisen URL-osoitteen ja menetelmän.

Määrittele pyyntö#

Anna työkalulle vakaa nimi ja kuvaus, joka selittää sen tarkoituksen, tärkeät rajat ja muuttaako se tietoja. Valitse dokumentoitu HTTP-menetelmä ja päätepiste. Käytä paikkamerkkejä vain muuttujapolun elementeille, jotka toiminto todella sallii.

Kuvitteellisessa tietuehaussa polku saattaa sisältää tietueen tunnisteen. Isäntänimen ja tilialueen tulee pysyä osana määritettyä yhteyttä avoimen mallisyötteen sijaan.

Määritä ja yhdistä syötteet#

Käytä syöttöskeemaa kunkin kentän, sen tyypin, pakollisen tilan ja kelvollisten arvojen kuvaamiseen. Pieni kaavio kuvitteelliselle haulle on:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Yhdistä argumentit dokumentoituun polkuun, kyselyyn tai runkokenttiin. Tarkista, että puuttuvat pakolliset kentät ja odottamattomat lisäargumentit epäonnistuvat selvästi. Säilytä todennus tuetussa palvelinyhteydessä, ei kehotteessa, esimerkkiskeemassa tai kovakoodatussa työkaluotsikossa.

Muotoile tuloste#

Vastauksen kartoitus tai muunnos voi palauttaa työnkulun tarvitsemat kentät koko palveluvastauksen sijaan. Tarkista muunnettu tulos alkuperäiseen testitulokseen verrattuna. Älä poista tietueen tunnistetta, sivutustietoja tai virhetietoja, joita tarvitaan sen ymmärtämiseen, onko tulos täydellinen.

Tarkista käyttöasetukset#

Työkalun kokoonpano tukee aikakatkaisu-, välimuisti- ja uudelleenyritysasetuksia. Käytä välimuistia vain, kun vanhentunut data on hyväksyttävää; välimuistissa oleva luku ei sovellu lopulliseksi todisteeksi siitä, että kirjoitus on juuri valmis. Ei-idempotentin kirjoituksen uudelleen yrittäminen voi luoda kaksoiskappaleita, joten valitse uudelleenyritystoiminta API:n dokumentoiduista takuista.

Testaa oikeaa polkua#

Tarkista oikea syöttö, virheellinen syöttö, tyhjät tulokset, lupavirhe ja rajoitettu onnistunut puhelu. Testidiagnostiikka voi sisältää arkaluontoisia pyyntötietoja; tarkasta ne vain hyväksytyn järjestelmänvalvojan reitin kautta ja poista ne ennen jakamista. Katso testaus ennen kuin asiakas käyttää työkalua.