Byg og konfigurer et værktøj

Start med den officielle API-dokumentation for virksomhedstjenesten og en opgave, som din konto har tilladelse til at udføre. Et smalt, velbeskrevet værktøj er lettere at teste end et generisk værktøj, der accepterer en vilkårlig URL og metode.

Definer anmodningen#

Giv værktøjet et stabilt navn og en beskrivelse, der forklarer dets formål, vigtige begrænsninger og om det ændrer data. Vælg den dokumenterede HTTP-metode og det dokumenterede slutpunkt. Brug kun pladsholdere til de variable stielementer, som handlingen rent faktisk tillader.

For et fiktivt postopslag kan stien indeholde et post-id. Værtsnavnet og kontoområdet skal forblive en del af den konfigurerede forbindelse i stedet for åbent modelinput.

Definer og kortlæg input#

Brug inputskemaet til at beskrive hvert felt, dets type, påkrævede status og gyldige værdier.Et lille skema til et fiktivt opslag er:

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

Tilknyt argumenter til den dokumenterede sti, forespørgsel eller brødtekstfelter. Kontroller, at manglende obligatoriske felter og uventede ekstra argumenter tydeligt mislykkes. Bevar godkendelsen i den understøttede serverforbindelse, ikke i en prompt, et eksempelskema eller en hardkodet værktøjshoved.

Form outputtet#

Svartilknytning eller transformation kan returnere de felter, som arbejdsprocessen har brug for, i stedet for et helt tjenestesvar. Kontroller den transformerede udgang mod det oprindelige testresultat. Fjern ikke post-id'et, sideoplysningerne eller fejloplysningerne, der er nødvendige for at forstå, om resultatet er fuldstændigt.

Gennemgå driftsindstillinger#

Værktøjets konfiguration understøtter indstillinger for timeout, cachelagring og genforsøg. Brug kun cachelagring, når forældede data er acceptable; en cachelagret læsning er ikke egnet som endeligt bevis på, at en skrivning netop er afsluttet. Gentagelse af en ikke-idempotent skrivning kan skabe dubletter, så vælg genforsøgsadfærden ud fra API’ets dokumenterede garantier.

Test den rigtige vej#

Kontroller korrekt input, ugyldigt input, tomme resultater, tilladelsesfejl og et begrænset vellykket opkald. Testdiagnosticering kan indeholde følsomme anmodningsoplysninger. Undersøg dem kun via den godkendte administratorrute, og rediger dem, før du deler dem. Se testning før en kunde bruger værktøjet.